刷新工作流作业状态

请求服务读取指定作业的最新执行状态。返回的是本次读取到的状态，不代表对作业执行状态的强制变更。

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

调用前准备

先查询工作流作业列表取得工作流 ID 和执行 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

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

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

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

• $EXECUTION_ID：要刷新的作业执行 ID。

路径参数

参数	类型	说明
workflow_id	string	工作流 ID。
execution_id	string	作业 ID。

请求示例

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

成功响应

成功时返回 200。data.execution 与查询作业详情中的作业对象一致。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "execution": {
      "execution_id": "exec-001",
      "workflow_id": "wf-001",
      "status": "running",
      "available_actions": ["pause", "cancel"],
      "execution_mode": "one_shot",
      "input_payload": {},
      "vars_payload": {}
    }
  }
}

响应字段如下。

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.execution	object	刷新后读取到的执行详情。
data.execution.execution_id	string	执行 ID。
data.execution.workflow_id	string	工作流 ID。
data.execution.status	string	当前状态。
data.execution.available_actions	string（字符串数组）	当前允许的操作。
data.execution.execution_mode	string	执行模式。
data.execution.cron_expression	string	Cron 表达式；仅定时模式返回。
data.execution.input_payload	object	已展开的运行输入。
data.execution.vars_payload	object	已展开的运行变量。
data.execution.moi_task_id	string	任务标识；服务端已分配时返回。
data.execution.moi_case_id	string	案例标识；服务端已分配时返回。
data.execution.moi_workflow_def_id	string	工作流定义标识；服务端已分配时返回。
data.execution.moi_workflow_version_id	string	工作流版本标识；服务端已分配时返回。
data.execution.pause_scope	string	暂停范围；有值时返回。
data.execution.error	string	错误信息；有值时返回。
data.execution.started_at	string	开始时间；未产生时可能省略。
data.execution.ended_at	string	结束时间；未产生时可能省略。
data.execution.created_at	string	创建时间；未产生时可能省略。
data.execution.updated_at	string	最后更新时间；未产生时可能省略。

错误响应

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

常见 HTTP 错误

HTTP 状态码	错误代码	常见原因	建议操作
400	ErrParamInvalid	工作流 ID 或执行 ID 为空或无效。	使用列表或创建响应中的 ID。
401	ErrUnauthorized	缺少或无效的访问凭据。	检查 API Key 和工作区 Header。
403	ErrForbidden	当前身份没有工作流读取权限。	请求授予 workflow.read 权限。
404	ErrNotFound	作业不存在或不属于路径中的工作流。	核对工作流 ID 和执行 ID。
503	ErrServiceUnavailable	依赖服务暂不可用。	稍后重试。
500	ErrServer	服务端未能刷新状态。	稍后重试。

后续操作

状态更新后，需要产出时查询工作流作业结果。

最后更新于 2026 年 8 月 22 日