刷新工作流作业状态¶

读取一个工作流作业的最新状态，不会启动、暂停或取消作业。

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

调用前准备¶

先查看工作流作业详情，取得工作流 ID 和作业 ID。准备具有工作流读取权限的个人访问令牌和目标工作区 ID。

路径参数¶

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

调用示例

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

参数说明

参数	类型	是否必填	说明
`workflow_id`	string	是	工作流 ID。
`execution_id`	string	是	作业 ID。

成功响应¶

成功时返回 200 和当前读取到的作业详情。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "execution": {
      "execution_id": "run-001",
      "workflow_id": "wf-001",
      "status": "running",
      "execution_mode": "one_shot"
    }
  }
}

字段说明

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。
`execution`	object	当前作业详情。

下面表格展开 execution 对象；每一行是该对象的一个字段。

字段	类型	说明
`execution_id`	string	作业 ID。
`workflow_id`	string	工作流 ID。
`status`	string	当前或最终作业状态。
`available_actions`	array of string	当前状态下允许的操作。
`execution_mode`	string	执行方式。
`cron_expression`	string	Cron 表达式；定时触发时返回。
`input_payload`	object	已展开的运行输入。
`vars_payload`	object	已展开的运行变量。
`error`	string	错误信息；有值时返回。
`started_at`	string	开始时间；有值时返回。
`ended_at`	string	结束时间；有值时返回。
`updated_at`	string	最后更新时间；有值时返回。

错误响应¶

响应示例

{
  "code": "ErrNotFound",
  "msg": "未找到工作流作业",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	可读错误信息。
`data`	null	错误响应中为 `null`。

最后更新于 2026 年 9 月 6 日