删除工作流作业¶
删除一个工作流作业记录。此操作不可逆。
DELETE https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/{workflow_id}/executions/{execution_id}
调用前准备¶
先查询作业详情,确认作业已到达终态。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$WORKFLOW_ID:作业所属的工作流 ID。$EXECUTION_ID:要删除的作业执行 ID。
路径参数¶
参数 |
类型 |
说明 |
|---|---|---|
|
string |
工作流 ID。 |
|
string |
作业 ID。 |
请求示例¶
curl -X DELETE "https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/$WORKFLOW_ID/executions/$EXECUTION_ID" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
成功响应¶
当响应中的 code 为 OK 且 data.deleted 为 true 时,服务端已删除该作业记录。删除不可逆。
{
"code": "OK",
"msg": "OK",
"data": {
"deleted": true
}
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
boolean |
|
错误响应¶
{
"code": "ErrNotFound",
"msg": "资源不存在",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
工作流 ID 或执行 ID 为空或无效。 |
使用列表响应中的 ID。 |
|
|
缺少或无效的访问凭据。 |
检查 API Key 和工作区 Header。 |
|
|
当前身份没有工作流删除权限。 |
请求授予 |
|
|
作业不存在或不属于路径中的工作流。 |
核对工作流 ID 和执行 ID。 |
|
|
当前作业状态与删除操作冲突。 |
处理或等待当前执行后再删除。 |
|
|
依赖服务暂不可用。 |
稍后重试。 |
|
|
服务端未能删除作业记录。 |
稍后重试。 |
后续操作¶
查询工作流作业列表,确认该作业记录已不再出现。