调用算子 API 服务¶

调用已发布且已启用的算子 API 服务。响应返回本次调用的状态、结果或错误；HTTP 成功只表示调用接口已返回，仍应检查业务状态和结果。

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

调用前准备¶

先查看算子 API 服务配置，确认服务可调用，并取得算子 ID、版本、服务名称和输入定义。准备具有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求体¶

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

输入示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog/$NODE_ID/api-service/invoke" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "service_name": "'"$SERVICE_NAME"'",
    "type": "operator",
    "version": "'"$VERSION"'",
    "payload": {
      "sql": "SELECT now()"
    }
  }'

参数说明

参数	类型	是否必填	说明
`node_id`	string	是	要调用的算子 ID，位于请求路径中。
`service_name`	string	是	服务名称，使用服务配置响应返回的值。
`type`	string	是	固定为 `operator`。
`version`	string	是	已发布的算子版本。
`payload`	object	是	服务输入数据；字段和类型以服务配置返回的输入定义为准。

成功响应¶

响应返回本次调用的状态和服务输出。result 是服务返回的 JSON 文本，解析后的字段由算子决定。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "result": {
      "case_id": "case_01JEX4A1M2",
      "status": "COMPLETED",
      "result": "{\"count\":9}"
    }
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。
`result`	object	本次服务调用的结果。

调用结果

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

字段	类型	说明
`case_id`	string	本次调用 ID，可用于关联结果。
`status`	string	服务返回的运行状态。
`result`	string	服务返回的 JSON 文本；解析后的结构由算子决定。
`error`	string	服务返回的错误信息；运行失败时返回。

错误响应¶

响应示例

{
  "code": "ErrNotFound",
  "msg": "Resource not found",
  "data": null
}

字段说明

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

后续操作¶

需要核对服务状态或输入定义时，查看算子 API 服务配置。

最后更新于 2026 年 9 月 3 日