取消工作流重新运行

请求取消一个工作流重新运行分支。请求成功不表示分支已停止;请读取返回状态确认实际状态。

POST https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/{workflow_id}/executions/{execution_id}/reruns/{rerun_id}/cancel

调用前准备

查询重新运行详情,确认分支当前状态允许取消。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $WORKFLOW_ID:作业所属的工作流 ID。

  • $EXECUTION_ID:源作业执行 ID。

  • $RERUN_ID:要取消的重新运行 ID。

路径参数

参数

类型

说明

workflow_id

string

工作流 ID。

execution_id

string

源作业 ID。

rerun_id

string

重新运行 ID。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/$WORKFLOW_ID/executions/$EXECUTION_ID/reruns/$RERUN_ID/cancel" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200data.rerun 返回取消后的当前分支信息;请读取其状态确认实际结果。

{
  "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"
    }
  }
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.rerun.rerun_id

string

重新运行 ID。

data.rerun.branch_id

string

分支 ID。

data.rerun.source_execution_id

string

源作业 ID;仅在有值时返回。

data.rerun.mode

string

重新运行模式。

data.rerun.status

string

取消操作返回时的分支状态。

data.rerun.error

string

分支错误信息;仅在有错误时返回。

错误响应

{
  "code": "ErrNotFound",
  "msg": "资源不存在",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

路径参数无效。

检查工作流、作业和重新运行 ID。

401

ErrUnauthorized

凭据缺失或无效。

检查 API Key。

403

ErrForbidden

当前身份没有运行权限。

使用有权限的凭据,或联系管理员授权。

404

ErrNotFound

工作流、作业或重新运行分支不存在。

检查路径参数。

409

workflow_execution_not_terminal

源作业或分支当前状态不允许该操作。

读取详情后按当前状态处理。

500

ErrServer

服务端无法取消重新运行。

记录请求时间和错误信息后重试。

503

ErrServiceUnavailable

依赖服务不可用。

稍后重试。

后续操作

查询工作流重新运行详情确认最终状态。

最后更新于