暂停工作流¶

暂停指定工作流，并暂停该工作流当前可暂停的执行。

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

调用前准备¶

先查看工作流详情，确认要暂停的工作流。准备具有工作流管理权限的个人访问令牌和目标工作区 ID。

路径参数¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $WORKFLOW_ID 替换为实际值。

调用示例

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

参数说明

参数	类型	是否必填	说明
`workflow_id`	string	是	要暂停的工作流 ID。

成功响应¶

成功时返回 200。响应返回暂停后的工作流详情；其余工作流详情字段与查看工作流详情一致。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workflow": {
      "id": "wf-001",
      "name": "daily-import",
      "status": "paused",
      "available_actions": ["resume", "update", "delete"],
      "execution_summary": {
        "total_executions": 8,
        "active_executions": 0
      }
    }
  }
}

字段说明

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。
`workflow`	object	暂停后的工作流详情。

下面表格展开响应示例中 data 下的 workflow 对象；每一行是该对象的一个字段。

其中 execution_summary 是执行汇总对象，total_executions 和 active_executions 位于该对象中。

字段	类型	说明
`id`	string	工作流 ID。
`name`	string	工作流名称。
`status`	string	暂停后的状态。
`available_actions`	string（字符串数组）	当前状态允许的操作；再次调用前应重新读取。
`execution_summary`	object	执行汇总。
`total_executions`	integer	执行总数。
`active_executions`	integer	活动执行数。

错误响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误说明。
`data`	null	错误时为空。

后续操作¶

记录 data.workflow.id。需要继续该工作流时，恢复工作流；需要核对当前状态时，查看工作流详情。

最后更新于 2026 年 9 月 3 日