查看自定义算子详情

查看一个自定义算子的配置。可据此确认实现、输入输出定义和启用状态。

GET https://api.moi.matrixorigin.cn/v5/workflow/v2/custom-operators/$OPERATOR_ID

调用前准备

查看自定义算子列表,选择一个算子并取得自定义算子 ID。将该 ID 写入路径参数 operator_id。准备有目标工作区访问权限的个人访问令牌目标工作区 ID,分别通过 X-API-KeyX-Workspace-ID 请求头传递。

路径参数

curl "https://api.moi.matrixorigin.cn/v5/workflow/v2/custom-operators/$OPERATOR_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

字段

类型

是否必填

说明

operator_id

integer

必填

要查看的自定义算子 ID。

成功响应

响应返回算子配置。输入、输出和绑定配置以序列化内容返回,使用时按其中的字段定义配置工作流或测试输入。

响应字段如下。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 123,
    "node_id": "moi:custom.operator:workspace:text_counter",
    "name": "文本计数",
    "identifier": "text_counter",
    "description": "统计输入文本的字符数。",
    "version": "v1",
    "input_schema": "{\"type\":\"object\"}",
    "output_schema": "{\"type\":\"object\"}",
    "enabled": true
  }
}

字段

类型

是否必填

说明

code

string

成功时为OK。

msg

string

成功时为OK。

data.id

integer

自定义算子 ID。

data.node_id

string

工作流中的算子 ID。

data.name

string

算子名称。

data.identifier

string

算子标识。

data.description

string

算子说明;有值时返回。

data.version

string

算子版本;有值时返回。

data.language

integer

实现语言的数值编码;有值时返回。

data.kind

integer

算子类型的数值编码;有值时返回。

data.handler

string

处理函数;有值时返回。

data.isolation_level

string

隔离配置;有值时返回。

data.source_file_id

string

源文件 ID;使用源文件创建时返回。

data.input_schema

string

输入定义的序列化内容。

data.output_schema

string

输出定义的序列化内容。

data.binding_config

string

绑定配置的序列化内容;有值时返回。

data.created_by

string

创建者标识;有值时返回。

data.updated_by

string

最后更新者标识;有值时返回。

data.created_at

integer

创建时间戳;有值时返回。

data.updated_at

integer

最后更新时间戳;有值时返回。

data.base_node_id

string

内置绑定类型关联的基础算子;有值时返回。

data.base_node_version

string

内置绑定类型关联的基础算子版本;有值时返回。

data.catalog_id

integer

关联的 Catalog ID;有值时返回。

data.database_id

integer

关联的数据库 ID;有值时返回。

data.enabled

boolean

算子是否已启用。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

字段

类型

是否必填

说明

code

string

错误代码。

msg

string

可读错误信息。

data

null

错误响应中为 null。

后续操作

需要修改时更新自定义算子。已启用的 Python 代码类型可试运行自定义算子

最后更新于