查看算子 API 服务配置¶

查看一个工作流算子版本的发布状态，以及可调用服务的地址、名称和输入定义。

GET https://api.moi.matrixorigin.cn/v5/workflow/v2/workitems/catalog/{node_id}/api-service?version={version}

调用前准备¶

先查看工作流算子列表选择算子并取得算子 ID；再查看工作流算子详情选择要检查的版本。准备具有目标工作区访问权限的个人访问令牌和目标工作区 ID。

调用示例¶

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

调用示例

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

参数说明

参数	类型	是否必填	说明
`node_id`	string	是	算子 ID，位于请求路径中。
`version`	string	是	算子版本，位于查询参数中。

成功响应¶

成功时返回 200 和服务配置。服务未发布时先发布；服务已停用时先启用；服务可调用时使用服务名称和输入定义调用它。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "service": {
      "api_service_id": "api_2e859efcedc1e0efea48b465b2197784",
      "node_id": "moi:data.sql.process",
      "version": "v1",
      "service_name": "operator-api-37f61ebdaa18aa51",
      "status": "ready",
      "method": "POST",
      "path": "/workspaces/ws-001/dynamic-services/invoke",
      "input_schema": "{\"type\":\"object\",\"properties\":{\"sql\":{\"type\":\"string\"}}}"
    }
  }
}

字段说明

通用与标识

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。
`service`	object	算子 API 服务配置。

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

字段	类型	说明
`api_service_id`	string	服务 ID。
`operator_id`	integer	自定义算子来源时返回的自定义算子 ID。
`node_id`	string	已发布的算子 ID。
`version`	string	已发布的算子版本。
`service_name`	string	调用服务时必须传入的服务名称。
`status`	string	服务状态；`unpublished` 表示尚未发布，`ready` 表示可以调用，`disabled` 表示已停用。

调用与输入

字段	类型	说明
`result_mode`	string	服务的结果返回方式。
`auth_mode`	string	服务的认证方式。
`method`	string	调用服务使用的 HTTP 方法。
`path`	string	调用服务的相对路径，拼接在 `https://api.moi.matrixorigin.cn/v5` 后。
`input_schema`	string	输入数据定义，按其中字段和类型填写调用请求的 `payload`。
`output_schema`	string	输出数据定义；有值时返回。

运行配置

字段	类型	说明
`workflow_id`	string	服务对应的工作流 ID；有值时返回。
`workflow_def_id`	string	服务对应的工作流定义 ID；有值时返回。
`workflow_version_id`	string	服务对应的工作流版本 ID；有值时返回。
`compute_resource_id`	string	服务使用的计算资源 ID；有值时返回。
`timeout_seconds`	integer	单次调用超时时间，单位为秒；有值时返回。
`max_concurrency`	integer	最大并发调用数；有值时返回。
`rate_limit_per_min`	integer	每分钟最大调用数；有值时返回。

错误响应¶

响应示例

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

字段说明

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

后续操作¶

服务尚未发布时，发布算子 API 服务。服务已停用时，启用算子 API 服务。服务可调用时，使用服务配置返回的服务名称和输入定义调用算子 API 服务。

最后更新于 2026 年 9 月 11 日