Pause workflow job¶

Requests to pause the specified workflow job. Acceptance of the request does not mean that execution has stopped in all run units; please read the return status or query the details again to confirm.

HTTP
POST $CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/{workflow_id}/executions/{execution_id}/pause

Before you call this API¶

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

First query job details and check whether available_actions contains pause.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/$WORKFLOW_ID/executions/$EXECUTION_ID/pause" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter reference

Path parameters

Parameter	Type	Required	Description
`workflow_id`	string	Required	Workflow ID.
`execution_id`	string	Required	Job ID.

Successful response¶

Returns 200 on success. data.execution returns the current execution information processed by the server.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "execution": {
      "execution_id": "exec-001",
      "workflow_id": "wf-001",
      "status": "paused",
      "available_actions": ["resume", "cancel"],
      "execution_mode": "one_shot",
      "pause_scope": "workflow",
      "input_payload": {},
      "vars_payload": {}
    }
  }
}

Field reference

Field	Type	Description
`code`	string	`OK` when successful.
`msg`	string	`OK` when successful.
`data.execution.execution_id`	string	Execution ID.
`data.execution.workflow_id`	string	Workflow ID.
`data.execution.status`	string	Current execution status; use this to confirm whether it has been paused.
`data.execution.available_actions`	string[]	Currently allowed operations.
`data.execution.execution_mode`	string	Execution mode.
`data.execution.cron_expression`	string	Cron expression; only returned in timing mode.
`data.execution.pause_scope`	string	The pause range provided by the server; returned when there is a value.
`data.execution.input_payload`	object	Expanded run input.
`data.execution.vars_payload`	object	Expanded run variable.
`data.execution.moi_task_id`	string	Task ID; returned when the server has assigned it.
`data.execution.moi_case_id`	string	Case ID; returned when the server has assigned it.
`data.execution.moi_workflow_def_id`	string	Workflow definition identifier; returned when the server has assigned it.
`data.execution.moi_workflow_version_id`	string	Workflow version identifier; returned when the server has assigned it.
`data.execution.error`	string	Error message; returned if there is a value.
`data.execution.started_at`	string	Start time; returned if there is a value.
`data.execution.ended_at`	string	End time; returned if there is a value.
`data.execution.created_at`	string	Creation time; returned if there is a value.
`data.execution.updated_at`	string	Last updated time; returned if there is a value.

Error response¶

Response example

JSON
{
  "code": "ErrConflict",
  "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¶

Resume workflow job when you need to continue. Use the same job ID View workflow job details to confirm the status.

Last updated on Sep 15, 2026