停用算子 API 服务¶
停用已发布的算子 API 服务。停用成功后,不能再调用该服务。
POST https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog/$NODE_ID/api-service/disable?version=$VERSION
调用前准备¶
先查看服务配置,确认要停用的服务及其算子 ID 和版本。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID、算子 ID 和版本。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$NODE_ID:要停用的服务对应的算子 ID。$VERSION:要停用的服务对应的算子版本。
路径参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
要停用服务的算子 ID。 |
查询参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
算子版本。 |
请求示例¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/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"
成功响应¶
响应返回更新后的服务配置。服务已停用;必须先启用服务才能再次调用。
{
"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"
}
}
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
string |
服务 ID。 |
|
integer |
已发布的自定义算子 ID。 |
|
string |
算子 ID。 |
|
string |
算子版本。 |
|
string |
服务名称。 |
|
string |
更新后的服务状态; |
|
string |
服务的结果返回模式。 |
|
string |
服务的认证模式。 |
|
string |
服务调用方法;有值时返回。 |
|
string |
服务调用路径;有值时返回。 |
|
string |
服务关联的工作流 ID;有值时返回。 |
|
string |
服务关联的工作流定义 ID;有值时返回。 |
|
string |
服务关联的工作流版本 ID;有值时返回。 |
|
string |
输入 schema 的序列化内容;有值时返回。 |
|
string |
输出 schema 的序列化内容;有值时返回。 |
|
string |
服务使用的计算资源 ID;有值时返回。 |
|
integer |
单次调用超时时间,单位为秒;有值时返回。 |
|
integer |
最大并发调用数;有值时返回。 |
|
integer |
每分钟最大调用数;有值时返回。 |
|
object |
调用服务所需的信息;有值时返回。 |
|
object |
服务部署信息;有值时返回。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "请求参数无效",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
算子 ID 或 |
检查路径和查询参数。 |
|
|
个人访问令牌缺失或无效。 |
检查个人访问令牌和工作区 ID。 |
|
|
当前访问凭据没有管理服务的权限。 |
使用有权限的访问凭据,或联系管理员授权。 |
|
|
算子或对应服务不存在。 |
检查算子 ID 和版本。 |
|
|
服务端无法停用服务。 |
记录请求时间和错误信息后重试。 |
|
|
服务依赖暂不可用。 |
稍后重试。 |
后续操作¶
完成后查看算子 API 服务配置确认当前状态。