停用算子 API 服务

停用已发布的算子 API 服务。停用后不能再调用该服务。

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

调用前准备

查看算子 API 服务配置,确认服务当前可调用,并取得算子 ID 和版本。准备具有目标工作区访问权限的个人访问令牌目标工作区 ID

调用示例

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

curl -X POST "https://api.moi.matrixorigin.cn/v5/workflow/v2/workitems/catalog/$NODE_ID/api-service/disable?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": "disabled"
    }
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

object

响应数据。

service

object

更新后的服务信息。

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

字段

类型

说明

api_service_id

string

服务 ID。

node_id

string

算子 ID。

version

string

算子版本。

service_name

string

服务名称。

status

string

更新后的服务状态;disabled 表示不能调用。

错误响应

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

字段

类型

说明

code

string

错误代码。

msg

string

可读错误信息。

data

null

错误响应中为 null

后续操作

需要再次调用时,使用同一算子 ID 和版本启用算子 API 服务

最后更新于