查看工作流算子详情¶

查看一个工作流算子的可用版本、输入和输出定义。

GET https://api.moi.matrixorigin.cn/v5/workflow/v2/workitems/catalog/{node_id}

调用前准备¶

先查看工作流算子列表，选择算子并取得算子 ID。准备具有目标工作区访问权限的个人访问令牌和目标工作区 ID。

调用示例¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $NODE_ID 替换为实际值。

调用示例

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

参数说明

参数	类型	是否必填	说明
`node_id`	string	是	要查看的算子 ID，位于请求路径中。

成功响应¶

成功时返回 200 和该算子的目录定义。不同类型的算子会返回不同的配置字段。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "node_id": "moi:data.sql.process",
    "display_name": "SQL 处理",
    "versions": [
      {
        "version": "v1",
        "input_schema": "{\"type\":\"object\"}"
      }
    ]
  }
}

字段说明

算子信息

下面表格展开响应示例中的 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	算子目录定义；字段随算子类型变化。
`node_id`	string	算子 ID。
`display_name`	string	算子显示名称；有值时返回。
`short_description`	string	算子简短说明；有值时返回。
`category`	string	算子所属分类；有值时返回。
`tags`	array of string	算子标签；有值时返回。
`source`	string	算子来源；有值时返回。
`provider`	string	算子提供方；有值时返回。
`preferred_version`	string	推荐使用的版本；有值时返回。
`visibility`	string	算子可见性；有值时返回。
`versions`	array of object	可用版本定义，按版本从新到旧排列；有值时返回。

版本信息

下面表格展开 versions 列表；每一行是一个可用版本的字段。

字段	类型	说明
`version`	string	版本号；有值时返回。
`description`	string	版本说明；有值时返回。
`visibility`	string	版本可见性；有值时返回。
`stream`	boolean	该版本是否为流式算子。
`source`	string	该版本的来源；有值时返回。
`provider`	string	该版本的提供方；有值时返回。
`input_schema`	string	输入定义的序列化内容；有值时返回。
`output_schema`	string	输出定义的序列化内容；有值时返回。
`data_flow`	object	数据流定义；有值时返回。

错误响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	可读错误信息。
`data`	null	错误响应中为 `null`。

后续操作¶

选择一个可用版本后，携带算子 ID 和版本发布算子 API 服务。

最后更新于 2026 年 9 月 28 日