删除工作流

删除一个工作流。删除不可逆,工作流的触发器、Cron、执行记录和工作流版本一并删除。

DELETE https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/{workflow_id}

调用前准备

查询工作流详情,确认没有进行中的执行。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用:

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

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

  • $WORKFLOW_ID:要删除的工作流 ID。

存在未完成执行时,删除请求会被拒绝。先等待或处理这些执行。

路径参数

参数

类型

说明

workflow_id

string

要删除的工作流 ID。

请求示例

curl -X DELETE "https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/$WORKFLOW_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

当响应中的 codeOKdata.deletedtrue 时,工作流及其触发器、Cron、执行记录和工作流版本已删除。删除不可逆。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "deleted": true
  }
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.deleted

boolean

true 表示删除已完成。

错误响应

存在 preparingsubmittedtriggeredscheduledrunningpaused 的执行时,删除会返回冲突而不会删除工作流。

{
  "code": "ErrConflict",
  "msg": "资源状态冲突",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

401

ErrUnauthorized

缺少或无效的访问凭据。

检查 API Key 和工作区 Header。

403

ErrForbidden

当前身份没有工作流删除权限。

请求授予工作流删除权限。

404

ErrNotFound

工作流不存在或不属于当前工作区。

核对工作区和工作流 ID。

409

ErrConflict

存在未完成执行或其他删除阻塞条件。

等待或处理未完成执行后再删除。

500

ErrServer

服务端删除失败。

稍后重试。

后续操作

查询工作流列表确认工作流已移除。

最后更新于