取消工作流重新运行¶
请求取消一个工作流重新运行分支。请求成功不表示分支已停止;请读取返回状态确认实际状态。
POST https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/{workflow_id}/executions/{execution_id}/reruns/{rerun_id}/cancel
调用前准备¶
先查看工作流重新运行详情,确认分支当前允许取消。准备具有目标工作区访问权限的个人访问令牌和目标工作区 ID。
调用示例¶
将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$WORKFLOW_ID、$EXECUTION_ID 和 $RERUN_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"
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
工作流 ID,位于请求路径中。 |
|
string |
是 |
源作业 ID,位于请求路径中。 |
|
string |
是 |
要取消的重新运行 ID,位于请求路径中。 |
成功响应¶
成功时返回 200,并返回重新运行分支的当前信息。
{
"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"
}
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
object |
响应数据。 |
|
object |
重新运行分支信息。 |
下面表格展开响应示例中 data 下的 rerun 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
重新运行 ID。 |
|
string |
分支 ID。 |
|
string |
源作业 ID;有值时返回。 |
|
string |
重新运行方式。 |
|
string |
取消操作返回时的分支状态。 |
|
string |
分支错误信息;有错误时返回。 |
错误响应¶
{
"code": "ErrNotFound",
"msg": "资源不存在",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
可读错误信息。 |
|
null |
错误响应中为 |
后续操作¶
查看工作流重新运行详情确认最终状态。
最后更新于