Disable operator API service¶

Deactivate the published operator API service. After successful deactivation, the service can no longer be called.

HTTP
POST $CLOUDSIGMA_API_BASE/workflow/v2/workitems/catalog/$NODE_ID/api-service/disable?version=$VERSION

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

First View Service Configuration, confirm the service to be deactivated and its operator ID and version.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/workflow/v2/workitems/catalog/$NODE_ID/api-service/disable?version=$VERSION" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter reference

Request parameters

Parameter	Type	Required	Description
`node_id`	string	Required	The ID of the operator to deactivate the service.
`version`	string	Required	Operator version.

Successful response¶

The response returns the updated service configuration. The service has been deactivated; the service must be enabled before it can be called again.

The response fields are as follows.

Response example

JSON
{
  "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"
    }
  }
}

Field reference

Field	Type	Description
`code`	string	OK on success.
`msg`	string	OK on success.
`data.service.api_service_id`	string	Service ID.
`data.service.operator_id`	integer	Published custom operator ID.
`data.service.node_id`	string	Operator ID.
`data.service.version`	string	Operator version.
`data.service.service_name`	string	Service name.
`data.service.status`	string	The updated service status; disabled means it cannot be called.
`data.service.result_mode`	string	The result return mode of the service.
`data.service.auth_mode`	string	The authentication mode of the service.
`data.service.method`	string	Service calling method; returned if there is a value.
`data.service.path`	string	Service call path; returned if there is a value.
`data.service.workflow_id`	string	The workflow ID associated with the service; returned if there is a value.
`data.service.workflow_def_id`	string	The workflow definition ID associated with the service; returned if there is a value.
`data.service.workflow_version_id`	string	The workflow version ID associated with the service; returned if there is a value.
`data.service.input_schema`	string	The serialized content of the input schema; returned if there is a value.
`data.service.output_schema`	string	Output the serialized content of schema; return if there is a value.
`data.service.compute_resource_id`	string	The computing resource ID used by the service; returned if there is a value.
`data.service.timeout_seconds`	integer	Timeout for a single call, in seconds; returned if there is a value.
`data.service.max_concurrency`	integer	The maximum number of concurrent calls; returned when there is a value.
`data.service.rate_limit_per_min`	integer	Maximum number of calls per minute; returned if there is a value.
`data.service.invoke`	object	Information required to call the service; returned if there is a value.
`data.service.deployment`	object	Service deployment information; returned if there is a value.

Error response¶

Response example

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

Field reference

Field	Type	Description
`code`	string	Error code.
`msg`	string	Readable error message.
`data`	null	`null` in an error response.

Follow-up operations¶

After completion View operator API service configuration confirms the current status.

Last updated on Sep 15, 2026