# 查询工作流版本列表

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

列出指定工作流定义下的全部版本记录，包含 `draft`、`published` 和 `deprecated` 状态。结果按版本号（`Version`）升序排列，相同版本号按版本 `ID` 字典序排列，不分页返回全部匹配条目。

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

## 调用前准备

1. 准备具有工作流版本读取权限的[个人访问令牌](../../../../../../guides/genesis/api-keys.md#创建和管理个人访问令牌)和[目标工作区 ID](../../../../../../guides/ai-studio/resource-center/workspace.md#复制工作区-id)。
2. 先调用[查询工作流列表](../list-workflows.md)取得目标工作流 ID。

## 请求参数

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

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl "https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/$WORKFLOW_ID/versions" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"
```

:::::
:::::{tab-item} 参数说明

### 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workflow_id` | string | 是 | 目标工作流 ID，可从[查询工作流列表](../list-workflows.md)取得。 |

:::::
::::::
:::::::

## 成功响应

返回 HTTP `200` 及 `data.items` 版本数组；当工作流定义下尚无版本记录时，`data.items` 返回空数组 `[]`。数组内每个版本对象的字段名保持 PascalCase 大小写。

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "items": [
      {
        "ID": "ver-001",
        "WorkspaceID": "ws-001",
        "UserID": "user-001",
        "WorkflowDefinitionID": "def-001",
        "Version": 1,
        "WorkflowJSON": "{\"name\":\"daily-import\",\"nodes\":[]}",
        "Status": "published",
        "CreatedBy": "user-001",
        "CreatedAt": "2026-10-14T08:00:00Z",
        "PublishedAt": "2026-10-14T08:05:00Z",
        "Type": 1,
        "InputSchema": "",
        "OutputSchema": "",
        "ResultMode": 0,
        "Description": "初始发布版本",
        "RuntimeSpecJSON": ""
      },
      {
        "ID": "ver-002",
        "WorkspaceID": "ws-001",
        "UserID": "user-001",
        "WorkflowDefinitionID": "def-001",
        "Version": 2,
        "WorkflowJSON": "{\"name\":\"daily-import\",\"nodes\":[]}",
        "Status": "draft",
        "CreatedBy": "user-001",
        "CreatedAt": "2026-10-14T09:00:00Z",
        "PublishedAt": "0001-01-01T00:00:00Z",
        "Type": 1,
        "InputSchema": "",
        "OutputSchema": "",
        "ResultMode": 0,
        "Description": "新增输入字段校验",
        "RuntimeSpecJSON": ""
      }
    ]
  }
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 请求处理成功时为 `OK`。 |
| `msg` | string | 请求处理结果说明，成功时为 `OK`。 |
| `data` | object | 本次查询返回的数据。 |
| `data.items` | array of object | 工作流版本列表，按 `Version` 升序排列。 |
| `data.items[].ID` | string | 工作流版本 ID，可用于[查询工作流版本详情](get-workflow-version.md)、[发布工作流版本](publish-workflow-version.md)、[废弃工作流版本](deprecate-workflow-version.md)或[删除工作流版本](delete-workflow-version.md)。 |
| `data.items[].WorkspaceID` | string | 版本所属工作区 ID。 |
| `data.items[].UserID` | string | 工作流所有者用户 ID。 |
| `data.items[].WorkflowDefinitionID` | string | 版本所属的工作流定义 ID。 |
| `data.items[].Version` | integer | 正整数版本号，从 `1` 开始递增，可用于[按版本号查询工作流版本](get-workflow-version-by-number.md)。 |
| `data.items[].WorkflowJSON` | string | 保存的工作流定义 JSON 字符串。 |
| `data.items[].Status` | string | 版本状态，取值为 `draft`、`published` 或 `deprecated`。 |
| `data.items[].CreatedBy` | string | 创建该版本的用户 ID。 |
| `data.items[].CreatedAt` | string | 版本创建时间，采用 RFC 3339 格式。 |
| `data.items[].PublishedAt` | string | 版本发布时间，采用 RFC 3339 格式；未发布时为 `0001-01-01T00:00:00Z`。 |
| `data.items[].Type` | integer | 版本类型编码：`1` 表示工作流，`2` 表示动态 API 服务。 |
| `data.items[].InputSchema` | string | 保存的输入 Schema JSON 字符串；未设置时为空字符串 `""`。 |
| `data.items[].OutputSchema` | string | 保存的输出 Schema JSON 字符串；未设置时为空字符串 `""`。 |
| `data.items[].ResultMode` | integer | 结果模式编码：`0` 表示未指定，`1` 表示单次返回，`2` 表示流式返回。 |
| `data.items[].Description` | string | 版本说明；未设置时为空字符串 `""`。 |
| `data.items[].RuntimeSpecJSON` | string | 保存的运行规范 JSON 字符串；未设置时为空字符串 `""`。 |

:::::
::::::
:::::::

## 错误响应

工作流不存在、工作流未绑定工作流定义，或当前身份无权读取目标工作流时，返回 `404`（`ErrNotFound`）或 `403`（`ErrForbidden`）。

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "ErrNotFound",
  "msg": "Not Found"
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 错误代码，例如 `ErrWorkspaceRequired`、`ErrForbidden`、`ErrNotFound` 或 `ErrServer`。 |
| `msg` | string | 可读错误信息。 |

:::::
::::::
:::::::
