查询自定义算子详情

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

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

调用前准备

先查询自定义算子列表，确认要查看的算子。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和自定义算子 ID。

下方示例使用：

• $AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。

• $WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。

• $OPERATOR_ID：要查看的自定义算子 ID，从查询自定义算子列表响应中取得，并写入请求地址。

路径参数

参数	类型	是否必填	说明
operator_id	integer	是	要查看的自定义算子 ID，必须大于 0。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/workflow/v2/custom-operators/$OPERATOR_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_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
}

常见 HTTP 错误

HTTP 状态码	错误代码	常见原因	建议操作
400	ErrParamInvalid	自定义算子 ID 不是正整数。	提供大于 0 的算子 ID。
401	ErrUnauthorized	个人访问令牌缺失或无效。	检查个人访问令牌和工作区 ID。
403	ErrForbidden	当前身份没有读取该算子的权限。	使用有权限的凭据，或联系管理员授权。
404	ErrNotFound	算子不存在。	检查算子 ID。
500	ErrServer	服务暂时无法读取算子。	记录错误信息后重试。

后续操作

需要修改时更新自定义算子。返回列表时查询自定义算子列表。

最后更新于 2026 年 8 月 22 日