View workflow job details¶

Read the current execution information of the specified workflow job. HTTP success only means successful reading, and the job result should be judged based on the execution status in the response.

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

Before you call this API¶

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

First query the workflow job list to obtain the workflow ID and execution ID.

Request¶

Input examples

Shell
curl "$CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/$WORKFLOW_ID/executions/$EXECUTION_ID" \
  -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. Determine the current or final status of the job based on data.execution.status.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "execution": {
      "execution_id": "exec-001",
      "workflow_id": "wf-001",
      "status": "running",
      "available_actions": ["pause", "cancel"],
      "execution_mode": "one_shot",
      "input_payload": {
        "source": "file-001"
      },
      "vars_payload": {},
      "moi_task_id": "task-001",
      "moi_case_id": "case-001",
      "started_at": "2026-08-18T10:00:00Z",
      "created_at": "2026-08-18T10:00:00Z"
    }
  }
}

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.
`data.execution.available_actions`	string[]	Current executable operations.
`data.execution.execution_mode`	string	Execution mode.
`data.execution.cron_expression`	string	Cron expression; may be omitted if not configured.
`data.execution.input_payload`	object	The running input after the server is expanded.
`data.execution.vars_payload`	object	The running variable after the server is expanded.
`data.execution.moi_task_id`	string	Server task ID; returned if there is a value.
`data.execution.moi_case_id`	string	Server case identifier; returned if there is a value.
`data.execution.moi_workflow_def_id`	string	Workflow definition identifier; returned if there is a value.
`data.execution.moi_workflow_version_id`	string	Workflow version identifier; returned if there is a value.
`data.execution.pause_scope`	string	Pause range; returned when there is a value.
`data.execution.error`	string	Error message; returned if there is a value.
`data.execution.started_at`	string	Start time; may be omitted if not generated.
`data.execution.ended_at`	string	End time; may be omitted if not generated.
`data.execution.created_at`	string	Creation time; may be omitted if not generated.
`data.execution.updated_at`	string	Last updated time; may be omitted if not generated.

Error response¶

Response example

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

You can Refresh Workflow Job Status while the job is still in progress. When output is needed query workflow job results.

Last updated on Sep 15, 2026