# 按版本号查询工作流版本

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

按从 `1` 开始的正整数版本号读取指定工作流的单个版本详情，支持读取 `draft`、`published` 或 `deprecated` 状态的版本。

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

## 调用前准备

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

## 请求参数

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

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

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

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

### 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workflow_id` | string | 是 | 目标工作流 ID，可从[查询工作流列表](../list-workflows.md)取得。 |
| `version_number` | integer | 是 | 正整数版本号（大于或等于 `1`），可从[查询工作流版本列表](list-workflow-versions.md)返回的 `Version` 字段取得。 |

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

## 成功响应

返回 HTTP `200` 及匹配版本号的工作流版本对象。版本对象的字段名保持 PascalCase 大小写。

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

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "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.ID` | string | 工作流版本 ID。 |
| `data.WorkspaceID` | string | 版本所属工作区 ID。 |
| `data.UserID` | string | 工作流所有者用户 ID。 |
| `data.WorkflowDefinitionID` | string | 版本所属的工作流定义 ID。 |
| `data.Version` | integer | 正整数版本号，与路径参数 `version_number` 一致。 |
| `data.WorkflowJSON` | string | 保存的工作流定义 JSON 字符串。 |
| `data.Status` | string | 版本状态，取值为 `draft`、`published` 或 `deprecated`。 |
| `data.CreatedBy` | string | 创建该版本的用户 ID。 |
| `data.CreatedAt` | string | 版本创建时间，采用 RFC 3339 格式。 |
| `data.PublishedAt` | string | 版本发布时间，采用 RFC 3339 格式；未发布时为 `0001-01-01T00:00:00Z`。 |
| `data.Type` | integer | 版本类型编码：`1` 表示工作流，`2` 表示动态 API 服务。 |
| `data.InputSchema` | string | 保存的输入 Schema JSON 字符串；未设置时为空字符串 `""`。 |
| `data.OutputSchema` | string | 保存的输出 Schema JSON 字符串；未设置时为空字符串 `""`。 |
| `data.ResultMode` | integer | 结果模式编码：`0` 表示未指定，`1` 表示单次返回，`2` 表示流式返回。 |
| `data.Description` | string | 版本说明；未设置时为空字符串 `""`。 |
| `data.RuntimeSpecJSON` | string | 保存的运行规范 JSON 字符串；未设置时为空字符串 `""`。 |

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

## 错误响应

`version_number` 无法解析为整数时返回 `400`（`ErrParamInvalid`）；目标工作流或对应版本号不存在时返回 `404`（`ErrNotFound`）；`version_number` 小于 `1` 时会因版本号无效而失败。

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

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

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

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

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