取消工作流作业¶

取消一个可取消的工作流作业。请求成功表示取消请求已被接受。

POST https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/{workflow_id}/executions/{execution_id}/cancel

调用前准备¶

先查看工作流作业详情，确认该作业当前可以取消。准备具有工作流运行权限的个人访问令牌和目标工作区 ID。

路径参数¶

参数	类型	是否必填	说明
`workflow_id`	string	是	工作流 ID。
`execution_id`	string	是	作业 ID。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$WORKFLOW_ID、$EXECUTION_ID 和取消原因替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/$WORKFLOW_ID/executions/$EXECUTION_ID/cancel" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "reason": "不再需要本次运行"
  }'

参数说明

参数	类型	是否必填	说明
`reason`	string	否	取消原因。

成功响应¶

成功时返回 200，表示服务已接受取消请求，并返回当时的作业详情。响应中的作业状态可能仍为运行中的当前状态；请继续查询作业详情或结果确认最终状态。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "execution": {
      "execution_id": "run-001",
      "workflow_id": "wf-001",
      "status": "running",
      "execution_mode": "one_shot"
    }
  }
}

字段说明

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。
`execution`	object	服务接受取消请求时返回的作业详情。

下面表格展开 execution 对象；每一行是该对象的一个字段。

字段	类型	说明
`execution_id`	string	作业 ID。
`workflow_id`	string	工作流 ID。
`status`	string	服务接受取消请求时的当前作业状态；不能仅凭本次响应确认最终取消状态。
`available_actions`	array of string	当前状态下允许的操作。
`execution_mode`	string	执行方式。
`error`	string	错误信息；有值时返回。
`updated_at`	string	最后更新时间；服务端提供时返回。

错误响应¶

响应示例

{
  "code": "ErrConflict",
  "msg": "当前状态不能取消",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	可读错误信息。
`data`	null	错误响应中为 `null`。

后续操作¶

使用作业 ID 查看工作流作业详情或查看工作流作业结果。

最后更新于 2026 年 9 月 28 日