发布算子 API 服务

将指定版本的工作流算子发布为 API 服务。发布后查看服务配置，确认服务状态和调用所需信息。

POST https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog/{node_id}/api-service

调用前准备

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

请求体

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

输入示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog/$NODE_ID/api-service" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "version": "'"$VERSION"'",
    "timeout_seconds": 30
  }'

参数说明

参数	类型	是否必填	说明
node_id	string	是	要发布的算子 ID，位于请求路径中。
version	string	是	要发布的算子版本。
compute_resource_id	string	否	为服务指定计算资源 ID。
timeout_seconds	integer	否	单次调用超时时间，单位为秒；不传或传 0 时为 30，最大值为 300。
max_concurrency	integer	否	最大并发调用数，不能为负数。
rate_limit_per_min	integer	否	每分钟最大调用数，不能为负数。

成功响应

成功时返回 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",
      "result_mode": "<result_mode>",
      "invoke": {
        "method": "POST",
        "path": "/workspaces/ws-001/dynamic-services/invoke",
        "result_mode": "<result_mode>",
        "body_example": {
          "service_name": "operator-api-37f61ebdaa18aa51",
          "payload": {}
        }
      }
    }
  }
}

字段说明

通用与标识

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data	object	响应数据。
service	object	发布后的服务信息。

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

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

调用与运行配置

字段	类型	说明
result_mode	string	服务的结果返回方式。
auth_mode	string	服务的认证方式。
method	string	调用服务使用的 HTTP 方法。
path	string	调用服务的相对路径，拼接在 https://moi.matrixorigin.cn/newmoi 后。
input_schema	string	输入数据定义；有值时返回。
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	每分钟最大调用数；有值时返回。

调用信息

当服务返回 invoke 时，优先使用其中的字段构造调用请求。body_example 仅展示请求形状；将其中的占位值和 payload 替换为服务输入定义要求的实际值。

字段	类型	说明
invoke	object	服务调用信息；有值时返回。
invoke.method	string	调用服务使用的 HTTP 方法。
invoke.path	string	调用服务的相对路径。
invoke.result_mode	string	本次调用的结果返回方式。
invoke.body_example	object	调用请求体示例。
invoke.body_example.service_name	string	调用时传入的服务名称。
invoke.body_example.payload	object	按输入定义填写的服务输入。

错误响应

响应示例

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

字段说明

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

后续操作

使用同一算子 ID 和版本查看算子 API 服务配置，确认服务状态、名称和输入定义。

最后更新于 2026 年 9 月 3 日