# 获取基础模型版本列表

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

`POST https://ark.cn-beijing.volcengineapi.com/?Action=ListFoundationModelVersions&Version=2024-01-01`

列出基础模型版本。

> **说明：注意**
>
> 本接口仅返回基础模型已发布或下线中的版本元数据，未发布版本的可见性受账号权限控制。

## 鉴权

本接口支持鉴权方式如下，详情请参见 [Base URL 及鉴权](/docs/base-url-and-authentication)。

* Access Key 鉴权，请在 [Access Key 管理](https://console.volcengine.com/iam/keymanage) 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。

---

<span id="request-parameters"></span>
## 请求参数

### Body 参数

**FoundationModelName** `string` `必选` | 基础模型名称

待查询版本列表的基础模型名称。可通过调用 ListFoundationModels 接口获取。

**Filter** `object` | 筛选条件

版本列表筛选条件。

**Description** `string` | 描述匹配

`Filter.Description`

按版本描述模糊匹配。

**ModelVersions** `string[]` | 版本号匹配

`Filter.ModelVersions`

按版本号精准匹配。

**Statuses** `string[]` | 状态匹配

`Filter.Statuses`

按版本状态精准匹配。可指定值：`Unpublished`、`Published`、`Retiring`。

**PageNumber** `integer` `默认值 1` | 起始页码

分页查询起始页码，从 1 开始。

**PageSize** `integer` `默认值 10` | 每页记录数

分页查询每页返回的记录数。

**取值范围**：`[1, 100]`

**ProjectName** `string` | 项目名称

资源所属的项目名称。

**SortBy** `string` `默认值 CreateTime` | 排序字段

排序字段。可指定值：

- `CreateTime`：按创建时间排序
- `UpdateTime`：按更新时间排序。

**SortOrder** `string` `默认值 Desc` | 排序方向

排序方向。可指定值：

- `Asc`：升序排列
- `Desc`：降序排列。

## 响应参数

**Items** `object[]` | 版本列表

当前页的基础模型版本列表。

**CreateTime** `string` | 创建时间

`Items.CreateTime`

版本创建时间，RFC3339 格式。

**FoundationModelName** `string` | 基础模型名称

`Items.FoundationModelName`

版本所属的基础模型名称。

**ModelVersion** `string` | 版本号

`Items.ModelVersion`

基础模型版本号。

**Status** `string` | 版本状态

`Items.Status`

版本生命周期状态。可指定值：

- `Unpublished`：未发布
- `Published`：已发布
- `Retiring`：下线中

**UpdateTime** `string` | 更新时间

`Items.UpdateTime`

版本最近更新时间，RFC3339 格式。

**ActiveConfigurationId** `string` | 生效配置 ID

`Items.ActiveConfigurationId`

当前生效的版本配置 ID。

**Description** `string` | 版本描述

`Items.Description`

版本描述信息。

**PublishTime** `string` | 发布时间

`Items.PublishTime`

版本发布时间，RFC3339 格式。

**PageNumber** `integer` | 当前页码

当前返回的页码。

**PageSize** `integer` | 每页记录数

当前返回的每页记录数。

**TotalCount** `integer` | 总数

命中筛选条件的基础模型版本总数。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=ListFoundationModelVersions&Version=2024-01-01' \
  -H 'Content-Type: application/json' \
  -H 'X-Date: <X-Date>' \
  -H 'X-Content-Sha256: <X-Content-Sha256>' \
  -H 'Authorization: HMAC-SHA256 Credential=<AK>/<X-Date>/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=<Signature>' \
  -d '{
  "FoundationModelName": "doubao-seed-2-0-pro",
  "PageNumber": 1,
  "PageSize": 10,
  "Filter": {
    "Description": "WU",
    "ModelVersions": [
      "783"
    ],
    "Statuses": [
      "M0"
    ]
  },
  "SortOrder": "Desc",
  "SortBy": "CreateTime"
}
'
```

#### Response

```
{
  "ResponseMetadata": {
    "RequestId": "2024051421010908503002501682D9A8",
    "Action": "ListFoundationModelVersions",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 1,
    "Items": [
      {
        "FoundationModelName": "doubao-seed-2-0-pro",
        "ModelVersion": "260215",
        "Description": "该版本包含最新推理与效果优化",
        "ActiveConfigurationId": "fmvc-20240914123456-abcde",
        "Status": "Published",
        "PublishTime": "2024-04-15T10:20:30Z",
        "CreateTime": "2024-04-01T11:54:41Z",
        "UpdateTime": "2024-05-14T20:59:45Z"
      }
    ]
  }
}
```