查看工作流作业列表

列出工作流作业,可按状态和执行方式筛选。

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

调用前准备

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

路径参数

参数

类型

是否必填

说明

workflow_id

string

工作流 ID。

查询参数

$AI_STUDIO_API_KEY$WORKSPACE_ID$WORKFLOW_ID 替换为实际值。

curl "https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/$WORKFLOW_ID/executions?offset=0&limit=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数

类型

是否必填

说明

offset

integer

从 0 开始的偏移量。

limit

integer

本次返回数量上限。

status

string

按作业状态筛选。

execution_mode

string

按执行方式筛选。

workflow_name

string

按工作流名称筛选;使用全局作业列表入口时适用。

成功响应

成功时返回 200 和作业列表。若返回项目数少于 limit,或已达到 total,则无需继续读取下一页。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "total": 1,
    "executions": [
      {
        "execution_id": "run-001",
        "workflow_id": "wf-001",
        "workflow_name": "daily-import",
        "status": "completed",
        "execution_mode": "one_shot"
      }
    ]
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

object

响应数据。

total

integer

匹配的作业总数。

executions

array of object

本页作业列表。

下面表格展开响应示例中 executions 列表的一项;每一行是一个作业字段。

字段

类型

说明

execution_id

string

作业 ID。

dispatch_job_id

string

派发作业 ID;有值时返回。

workflow_id

string

工作流 ID。

workflow_name

string

工作流名称;有值时返回。

status

string

当前或最终作业状态。

available_actions

array of string

当前状态下允许的操作。

execution_mode

string

执行方式。

cron_expression

string

Cron 表达式;定时触发时返回。

moi_task_id

string

服务端任务标识;有值时返回。

moi_case_id

string

服务端案例标识;有值时返回。

error

string

错误信息;有值时返回。

data_name

string

关联数据名称;有值时返回。

file_id

string

关联文件 ID;有值时返回。

started_at

string

开始时间;有值时返回。

ended_at

string

结束时间;有值时返回。

created_at

string

创建时间;有值时返回。

updated_at

string

最后更新时间;有值时返回。

错误响应

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

字段

类型

说明

code

string

错误代码。

msg

string

可读错误信息。

data

null

错误响应中为 null

后续操作

使用列表项的 execution_id 查看工作流作业详情

最后更新于