Cancel workflow rerun¶

Request to cancel a workflow and rerun a branch. A successful request does not mean that the branch has been stopped; please read the return status to confirm the actual status.

HTTP
POST $CLOUDSIGMA_API_BASE/workflow/v2/workflow-apps/{workflow_id}/executions/{execution_id}/reruns/{rerun_id}/cancel

Before you call this API¶

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

First query rerun details to confirm that the current status of the branch allows cancellation.

Request¶

Input examples

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

Parameter reference

Path parameters

Field	Type	Description
`workflow_id`	string	Workflow ID.
`execution_id`	string	Source job ID.
`rerun_id`	string	Rerun ID.

Successful response¶

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "rerun": {
      "rerun_id": "rerun-001",
      "branch_id": "branch-001",
      "source_execution_id": "exec-001",
      "mode": "continue_from_node",
      "status": "cancelled"
    }
  }
}

Field reference

Field	Type	Description
`code`	string	`OK` when successful.
`msg`	string	`OK` when successful.
`data.rerun.rerun_id`	string	Rerun ID.
`data.rerun.branch_id`	string	Branch ID.
`data.rerun.source_execution_id`	string	Source job ID; returned only if there is a value.
`data.rerun.mode`	string	Rerun mode.
`data.rerun.status`	string	The branch status when the cancellation operation returns.
`data.rerun.error`	string	Branch error information; only returned when there is an error.

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¶

View workflow rerun details confirms the final status.

Last updated on Sep 15, 2026