Refresh workflow job status¶

Requests the service to read the latest execution status of the specified job. What is returned is the status read this time and does not represent a forced change to the job execution status.

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

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 -X POST "$CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/$WORKFLOW_ID/executions/$EXECUTION_ID/refresh" \
  -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 is consistent with the job object in View workflow job details.

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

Field reference

Field	Type	Description
`code`	string	`OK` when successful.
`msg`	string	`OK` when successful.
`data.execution`	object	The execution details read after refreshing.
`data.execution.execution_id`	string	Execution ID.
`data.execution.workflow_id`	string	Workflow ID.
`data.execution.status`	string	Current status.
`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.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.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¶

After the status is updated, when output is required query workflow job results.

Last updated on Sep 15, 2026