Publish operator API service¶

Publish the specified version of the operator as a callable API service. Save the service name after successful publishing; it can be called after the service is enabled.

HTTP
POST $CLOUDSIGMA_API_BASE/workflow/v2/workitems/catalog/$NODE_ID/api-service

Before you call this API¶

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

First View operator list to confirm the operator to be released and its version.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/workflow/v2/workitems/catalog/$NODE_ID/api-service" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"version\": \"$VERSION\",
    \"timeout_seconds\": 30
  }"

Parameter reference

Request body

Parameter	Type	Required	Description
`node_id`	string	Required	The operator ID to be published. It can be obtained from the [View operator list](../operator-catalog/list-operators.md) response.
`version`	string	Required	The operator version to be released.
`compute_resource_id`	string		Specifies the computing resource ID for the service.
`timeout_seconds`	integer		Single call timeout, in seconds. When 0 is not passed or 0 is passed, it is 30, and the maximum value is 300.
`max_concurrency`	integer		The maximum number of concurrent calls, cannot be a negative number.
`rate_limit_per_min`	integer		Maximum number of calls per minute, cannot be negative.

Successful response¶

The response returns service identification, status, calling address and configuration. After successful publishing, the service can be called; use the returned service name as it is for call service.

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

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	Published operator ID.
`data.service.version`	string	Published operator version.
`data.service.service_name`	string	Service name.
`data.service.status`	string	Service status. ready means it can 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	The HTTP method used to call the service.
`data.service.path`	string	Relative path to the calling service.
`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.compute_resource_id`	string	The computing resource ID used; only 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.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.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