查看工作流列表¶

列出当前调用者可读取的工作流。可按来源、状态、运行方式或名称筛选。

GET https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps

调用前准备¶

准备具有工作流读取权限的个人访问令牌和目标工作区 ID。

查询参数¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和示例中的查询条件替换为实际值。

调用示例

首次读取

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

读取下一页

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

参数说明

参数	类型	是否必填	说明
`offset`	integer	否	返回列表的起始位置。
`limit`	integer	否	本次返回的最大数量。
`source_type`	string	否	按工作流来源类型筛选。
`status`	string	否	按当前工作流状态筛选。
`execution_mode`	string	否	按运行方式筛选。
`name_search`	string	否	按工作流名称搜索。
`include_dynamic_service`	boolean	否	是否返回动态服务工作流。

成功响应¶

成功时返回 200。响应包含符合筛选条件的工作流摘要和匹配总数；分页时继续增加 offset，直到已读取数量达到总数。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "total": 1,
    "workflows": [
      {
        "id": "wf-001",
        "name": "daily-import",
        "source_type": "manual_dsl",
        "status": "ready",
        "available_actions": ["update", "delete", "run", "pause"],
        "execution_mode": "cron",
        "cron_expression": "0 2 * * *",
        "latest_workflow_version_id": "ver-001",
        "latest_version": 3,
        "parameter_summary": {
          "status": "valid",
          "total_fields": 1,
          "required_fields": 0,
          "filled_required_fields": 0,
          "missing_required_fields": 0
        },
        "execution_summary": {
          "total_executions": 8,
          "active_executions": 0,
          "latest_execution_id": "run-008",
          "latest_execution_status": "completed"
        },
        "trigger_summary": {
          "mode": "cron",
          "configured": true,
          "enabled": true,
          "cron_expression": "0 2 * * *"
        },
        "created_at": "2026-08-18T10:00:00Z",
        "updated_at": "2026-08-18T11:00:00Z"
      }
    ]
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。
`total`	integer	符合当前筛选条件的工作流总数。
`workflows`	array	工作流摘要列表。

工作流摘要

下面表格展开响应示例中 data 下的 workflows 列表；每一行是列表中一个工作流的信息。

字段	类型	说明
`id`	string	工作流 ID。
`name`	string	工作流名称。
`description`	string	工作流说明；未设置时可能省略。
`source_type`	string	工作流来源类型。
`status`	string	当前工作流状态。
`available_actions`	array of string	当前状态允许的操作；再次调用前应重新读取。
`execution_mode`	string	已配置的运行方式。
`cron_expression`	string	Cron 表达式；仅定时触发时返回。
`draft_id`	string	草稿 ID；服务端提供时返回。
`candidate_id`	string	候选 ID；服务端提供时返回。
`latest_workflow_version_id`	string	最新工作流版本 ID；服务端提供时返回。
`latest_version`	integer	最新工作流版本号；服务端提供时返回。
`latest_version_status`	string	最新工作流版本状态；服务端提供时返回。
`compute_resource_id`	string	工作流级计算资源 ID；未关联时可能省略。
`created_at`	string	创建时间；服务端提供时返回。
`updated_at`	string	最后更新时间；服务端提供时返回。

参数与执行汇总

字段	类型	说明
`parameter_summary`	object	运行参数校验汇总。
`execution_summary`	object	执行汇总。

parameter_summary 用于查看运行参数是否齐全，execution_summary 用于查看历史执行情况。字段如下。

字段	类型	说明
`status`	string	参数校验状态。
`total_fields`	integer	参数总数。
`required_fields`	integer	必填参数数。
`filled_required_fields`	integer	已填写必填参数数。
`missing_required_fields`	integer	缺失必填参数数。
`missing_required_field_ids`	array of string	缺失参数 ID；没有缺失时可能省略。
`missing_required_field_labels`	array of string	缺失参数显示名称；没有缺失时可能省略。
`total_executions`	integer	执行总数。
`active_executions`	integer	活动执行数。
`active_execution_id`	string	当前活动执行 ID；没有活动执行时可能省略。
`active_execution_status`	string	当前活动执行状态；没有活动执行时可能省略。
`latest_execution_id`	string	最近一次执行 ID；没有执行记录时可能省略。
`latest_execution_status`	string	最近一次执行状态；没有执行记录时可能省略。
`latest_execution_at`	string	最近一次执行时间；没有执行记录时可能省略。

触发器与计算资源

字段	类型	说明
`trigger_summary`	object	触发器汇总。
`compute_resource_bindings`	array	工作流或节点的计算资源绑定。

trigger_summary 用于查看触发器，compute_resource_bindings 用于查看已关联的计算资源。字段如下。

字段	类型	说明
`mode`	string	触发方式。
`configured`	boolean	是否已配置。
`enabled`	boolean	是否已启用。
`volume_id`	integer	关联的卷 ID；仅卷触发时返回。
`cron_expression`	string	Cron 表达式；仅定时触发时返回。
`service_name`	string	服务名称；仅动态服务时返回。
`id`	string	计算资源 ID。
`name`	string	计算资源名称；服务端提供时返回。
`workflow_level`	boolean	是否为工作流级绑定。
`node_names`	array of string	使用该绑定的节点名称。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

字段说明

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

后续操作¶

记录每个工作流的 id。需要查看完整定义时，查看工作流详情；需要修改时，更新工作流。

最后更新于 2026 年 9 月 11 日