# 查询工作流列表

列出当前调用者可读取的工作流。先通过此接口找到工作流 ID，再查询详情、更新或启动作业。

```text
GET https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps
```

## 调用前准备

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

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：要查询的工作区 ID，通过 `X-Workspace-ID` Header 传递。

## 查询参数

不传查询参数时，接口返回起始位置的默认数量。使用筛选参数缩小结果范围；使用 `offset` 和 `limit` 分段读取结果。

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `offset` | integer | 否 | 返回列表的起始位置。 |
| `limit` | integer | 否 | 返回数量。 |
| `source_type` | string | 否 | 按来源类型筛选。 |
| `status` | string | 否 | 按工作流状态筛选。 |
| `execution_mode` | string | 否 | 按执行模式筛选。 |
| `name_search` | string | 否 | 按名称搜索。 |
| `include_dynamic_service` | boolean | 否 | 是否包含动态服务工作流。 |

## 请求示例

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

如需按名称筛选，将 `name_search` 作为查询参数追加到地址中。

## 成功响应

成功时返回 `200`。从 `data.workflows` 中取得当前身份可读取的工作流摘要，从 `data.total` 判断共有多少条匹配结果。

```json
{
  "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", "list_executions"],
        "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
        },
        "trigger_summary": {
          "mode": "cron",
          "configured": true,
          "enabled": true
        },
        "created_at": "2026-08-18T10:00:00Z",
        "updated_at": "2026-08-18T11:00:00Z"
      }
    ]
  }
}
```

响应字段如下。

本文中，字段路径中的 `[]` 表示数组中的每一项。例如，`items[].name` 表示 `items` 数组中每一项的 `name` 字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.total` | integer | 匹配当前筛选条件的工作流总数。 |
| `data.workflows` | object（对象数组） | 工作流摘要列表。 |
| `data.workflows[].id` | string | 工作流标识。 |
| `data.workflows[].name` | string | 工作流名称。 |
| `data.workflows[].description` | string | 工作流说明；未设置时可能省略。 |
| `data.workflows[].source_type` | string | 来源类型。 |
| `data.workflows[].status` | string | 当前状态。 |
| `data.workflows[].execution_mode` | string | 执行模式。 |
| `data.workflows[].available_actions` | string（字符串数组） | 服务端在当前状态下允许的操作；再次调用前应重新读取。 |
| `data.workflows[].cron_expression` | string | Cron 表达式；仅定时模式返回。 |
| `data.workflows[].draft_id` | string | 草稿标识；服务端提供时返回。 |
| `data.workflows[].candidate_id` | string | 候选标识；服务端提供时返回。 |
| `data.workflows[].latest_workflow_version_id` | string | 最新工作流版本标识；服务端提供时返回。 |
| `data.workflows[].latest_version` | integer | 最新工作流版本序号；服务端提供时返回。 |
| `data.workflows[].latest_version_status` | string | 最新工作流版本状态；服务端提供时返回。 |
| `data.workflows[].compute_resource_id` | string | 工作流级计算资源 ID；未关联时可能省略。 |
| `data.workflows[].compute_resource_bindings` | object（对象数组） | 工作流或节点的计算资源绑定；未配置时可能省略。 |
| `data.workflows[].compute_resource_bindings[].id` | string | 计算资源 ID。 |
| `data.workflows[].compute_resource_bindings[].name` | string | 计算资源名称。 |
| `data.workflows[].compute_resource_bindings[].workflow_level` | boolean | 是否为工作流级绑定。 |
| `data.workflows[].compute_resource_bindings[].node_names` | string（字符串数组） | 使用该绑定的节点名称。 |
| `data.workflows[].parameter_summary` | object | 运行参数的校验汇总。 |
| `data.workflows[].parameter_summary.status` | string | 参数校验状态。 |
| `data.workflows[].parameter_summary.total_fields` | integer | 参数总数。 |
| `data.workflows[].parameter_summary.required_fields` | integer | 必填参数数。 |
| `data.workflows[].parameter_summary.filled_required_fields` | integer | 已填写必填参数数。 |
| `data.workflows[].parameter_summary.missing_required_fields` | integer | 缺失必填参数数。 |
| `data.workflows[].parameter_summary.missing_required_field_ids` | string（字符串数组） | 缺失必填参数的标识；没有缺失时可能省略。 |
| `data.workflows[].parameter_summary.missing_required_field_labels` | string（字符串数组） | 缺失必填参数的显示名称；没有缺失时可能省略。 |
| `data.workflows[].execution_summary` | object | 执行汇总。 |
| `data.workflows[].execution_summary.total_executions` | integer | 执行总数。 |
| `data.workflows[].execution_summary.active_executions` | integer | 活动执行数。 |
| `data.workflows[].execution_summary.active_execution_id` | string | 当前活动执行标识；没有活动执行时可能省略。 |
| `data.workflows[].execution_summary.active_execution_status` | string | 当前活动执行状态；没有活动执行时可能省略。 |
| `data.workflows[].execution_summary.latest_execution_id` | string | 最近一次执行标识；没有执行记录时可能省略。 |
| `data.workflows[].execution_summary.latest_execution_status` | string | 最近一次执行状态；没有执行记录时可能省略。 |
| `data.workflows[].execution_summary.latest_execution_at` | string | 最近一次执行时间；没有执行记录时可能省略。 |
| `data.workflows[].trigger_summary` | object | 触发器汇总。 |
| `data.workflows[].trigger_summary.mode` | string | 触发方式。 |
| `data.workflows[].trigger_summary.configured` | boolean | 是否已配置。 |
| `data.workflows[].trigger_summary.enabled` | boolean | 是否启用。 |
| `data.workflows[].trigger_summary.volume_id` | integer | Volume 触发器关联的 Volume ID；仅适用时返回。 |
| `data.workflows[].trigger_summary.cron_expression` | string | 定时表达式；仅适用时返回。 |
| `data.workflows[].trigger_summary.service_name` | string | 服务名称；仅适用时返回。 |
| `data.workflows[].created_at` | string | 创建时间；服务端提供时返回。 |
| `data.workflows[].updated_at` | string | 最后更新时间；服务端提供时返回。 |

## 读取后续结果

根据 `data.total` 和请求时的 `limit` 计算分段次数，再依次增加 `offset` 读取后续结果。

## 错误响应

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

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - `offset` 或 `limit` 不能解析，或筛选参数不符合要求。
  - 检查查询参数类型和取值。
* - `401`
  - `ErrUnauthorized`
  - 缺少或无效的访问凭据。
  - 检查 API Key 和工作区 Header。
* - `403`
  - `ErrForbidden`
  - 当前身份没有读取工作流的权限。
  - 请求授予工作流读取权限。
* - `500`
  - `ErrServer`
  - 工作流服务处理失败。
  - 稍后重试；持续失败时联系管理员。
```

## 后续操作

使用 `data.workflows[].id` [查询工作流详情](get-workflow.md)。