# 查询模型开通列表

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

`POST https://ark.cn-beijing.volcengineapi.com/?Action=ListModelActivations&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 参数

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

模型激活列表的筛选条件，可按状态、厂商、域等维度过滤。

**DisplayName** `string` | 模型展示名称

`Filter.DisplayName`

按模型展示名称进行筛选。

**FoundationModelDomain** `string` | 模型域

`Filter.FoundationModelDomain`

按基础模型所属域进行筛选。

**FoundationModelNames** `string[]` | 模型名称列表

`Filter.FoundationModelNames`

按基础模型名称列表进行筛选，命中其中任一名称的模型均会返回。

**IncludeDeprecatedModels** `boolean` | 是否包含已下线模型

`Filter.IncludeDeprecatedModels`

是否在返回结果中包含已下线的模型。

**States** `string[]` | 状态筛选

`Filter.States`

按模型激活状态筛选。取值 `Available` 表示已开通、`Unavailable` 表示未开通。

**VendorName** `string` | 厂商名称

`Filter.VendorName`

按模型厂商名称进行筛选。

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

分页查询时的起始页码。

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

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

**SortBy** `string` `默认值 VendorName` | 排序指标

排序所依据的字段名。

**SortOrder** `string` `默认值 Desc` | 排序顺序

排序顺序。取值 `Desc` 表示降序、`Asc` 表示升序。

**WithFreeUsage** `boolean` | 是否附带免费额度信息

是否在返回结果中附带模型的免费推理额度信息。

**WithPrice** `boolean` | 是否附带价格信息

是否在返回结果中附带模型的计费价格信息。

## 响应参数

**Items** `object[]` | 模型激活列表

模型激活条目列表。每个元素包含一个基础模型的激活详情。

**ChargeItems** `object[]` | 计费项列表

`Items.ChargeItems`

模型的计费项列表。

**Price** `number` | 单价

`Items.ChargeItems.Price`

计费项的单价。

**Type** `string` | 计费项类型

`Items.ChargeItems.Type`

计费项的类型标识。

**UnitCode** `string` | 计量单位编码

`Items.ChargeItems.UnitCode`

计费项的计量单位编码。

**DiscountPriceEndTime** `string` | 折扣结束时间

`Items.ChargeItems.DiscountPriceEndTime`

折扣价格的结束时间。

**DiscountPriceStartTime** `string` | 折扣开始时间

`Items.ChargeItems.DiscountPriceStartTime`

折扣价格的生效起始时间。

**OriginalPrice** `number` | 原价

`Items.ChargeItems.OriginalPrice`

计费项的原始价格（折扣前）。

**DisplayName** `string` | 展示名称

`Items.DisplayName`

模型的展示名称。

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

`Items.FoundationModelName`

基础模型的唯一名称标识。

**FreeResourcePackItems** `object[]` | 免费资源包列表

`Items.FreeResourcePackItems`

模型关联的免费资源包列表。

**Consumed** `integer` | 已消耗量

`Items.FreeResourcePackItems.Consumed`

资源包中已消耗的数量。

**Reclaimed** `integer` | 已回收量

`Items.FreeResourcePackItems.Reclaimed`

资源包中已回收的数量。

**Total** `integer` | 总量

`Items.FreeResourcePackItems.Total`

资源包的总量。

**Type** `string` | 资源包类型

`Items.FreeResourcePackItems.Type`

资源包的类型。取值 `DataPermission` 表示数据权限、`FreeInference` 表示免费推理额度。

**SyncTime** `string` | 同步时间

`Items.FreeResourcePackItems.SyncTime`

资源包数据的最近同步时间。

**MultiChargeItems** `object[]` | 多档计费项列表

`Items.MultiChargeItems`

模型的多档计费项列表，支持按 Token 用量分档计价。

**ChargeItems** `object[]` | 计费项列表

`Items.MultiChargeItems.ChargeItems`

该档位下的计费项列表。

**Price** `number` | 单价

`Items.MultiChargeItems.ChargeItems.Price`

计费项的单价。

**Type** `string` | 计费项类型

`Items.MultiChargeItems.ChargeItems.Type`

计费项的类型标识。

**UnitCode** `string` | 计量单位编码

`Items.MultiChargeItems.ChargeItems.UnitCode`

计费项的计量单位编码。

**DiscountPriceEndTime** `string` | 折扣结束时间

`Items.MultiChargeItems.ChargeItems.DiscountPriceEndTime`

折扣价格的结束时间。

**DiscountPriceStartTime** `string` | 折扣开始时间

`Items.MultiChargeItems.ChargeItems.DiscountPriceStartTime`

折扣价格的生效起始时间。

**OriginalPrice** `number` | 原价

`Items.MultiChargeItems.ChargeItems.OriginalPrice`

计费项的原始价格（折扣前）。

**Description** `string` | 档位描述

`Items.MultiChargeItems.Description`

该计费档位的描述说明。

**MaxCompletionTokens** `integer` | 最大 Completion Token 数

`Items.MultiChargeItems.MaxCompletionTokens`

该档位对应的最大 Completion Token 数量。

**MaxPromptTokens** `integer` | 最大 Prompt Token 数

`Items.MultiChargeItems.MaxPromptTokens`

该档位对应的最大 Prompt Token 数量。

**Name** `string` | 档位名称

`Items.MultiChargeItems.Name`

该计费档位的名称。

**State** `string` | 开通状态

`Items.State`

模型的开通状态。取值 `Available` 表示已开通、`Unavailable` 表示未开通。

**SubServices** `object[]` | 子服务状态列表

`Items.SubServices`

模型关联的子服务及其开通状态列表。

**Status** `string` | 开通状态

`Items.SubServices.Status`

子服务的开通状态。取值 `Available` 表示已开通、`Unavailable` 表示未开通。

**SubService** `string` | 子服务类型

`Items.SubServices.SubService`

子服务的类型标识。

**VendorName** `string` | 厂商名称

`Items.VendorName`

模型所属厂商的名称。

**InitialInferenceFreeUsage** `object` | 初始免费推理额度

`Items.InitialInferenceFreeUsage`

模型开通时赠送的初始免费推理额度。

**Consumed** `number` | 已使用额度

`Items.InitialInferenceFreeUsage.Consumed`

已消耗的免费推理额度。

**Total** `number` | 总额度

`Items.InitialInferenceFreeUsage.Total`

免费推理的总额度。

**Instruction** `string` | 开通说明

`Items.Instruction`

模型的开通说明或备注信息。

**IsDeprecated** `boolean` | 是否已下线

`Items.IsDeprecated`

模型是否已下线。

**IsLimitedActivation** `boolean` | 是否限量开通

`Items.IsLimitedActivation`

模型是否为限量开通，即仅对部分用户开放。

**IsOverdue** `boolean` | 是否逾期

`Items.IsOverdue`

模型是否处于逾期状态。

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

当前返回结果对应的分页页码。

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

当前返回结果每页包含的记录数。

**TotalCount** `integer` | 总数

符合筛选条件的模型激活记录总数。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=ListModelActivations&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 '{
    "PageNumber": 1,
    "PageSize": 10,
    "SortOrder": "Desc",
    "SortBy": "VendorName",
    "Filter": {
        "States": [
            "Available"
        ],
        "VendorName": "火山方舟",
        "FoundationModelDomain": "Chat",
        "IncludeDeprecatedModels": false
    },
    "WithPrice": true,
    "WithFreeUsage": true
}
'
```

#### Response

```
{
    "ResponseMetadata": {
        "RequestId": "20240514212754E5F607182E04DEF708",
        "Action": "ListModelActivations",
        "Version": "2024-01-01",
        "Service": "ark",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 10,
        "Items": [
            {
                "FoundationModelName": "doubao-seed-2-0-pro",
                "State": "Available",
                "VendorName": "火山方舟",
                "DisplayName": "Doubao Seed 2.0 Pro",
                "ChargeItems": [
                    {
                        "Price": 0.0008,
                        "UnitCode": "CNY/1KToken",
                        "Type": "PromptToken"
                    },
                    {
                        "Price": 0.002,
                        "UnitCode": "CNY/1KToken",
                        "Type": "CompletionToken"
                    }
                ],
                "MultiChargeItems": [],
                "InitialInferenceFreeUsage": {
                    "Total": 500000,
                    "Consumed": 12580
                },
                "FreeResourcePackItems": [
                    {
                        "Total": 500000,
                        "Consumed": 12580,
                        "Type": "FreeInference",
                        "SyncTime": "2024-04-01T11:54:41Z",
                        "Reclaimed": 0
                    }
                ],
                "SubServices": [
                    {
                        "SubService": "Inference",
                        "Status": "Available"
                    }
                ],
                "Instruction": "",
                "IsOverdue": false,
                "IsLimitedActivation": false,
                "IsDeprecated": false
            },
            {
                "FoundationModelName": "doubao-seed-2-0-lite",
                "State": "Unavailable",
                "VendorName": "火山方舟",
                "DisplayName": "Doubao Seed 2.0 Lite",
                "ChargeItems": [
                    {
                        "Price": 0.0003,
                        "UnitCode": "CNY/1KToken",
                        "Type": "PromptToken"
                    },
                    {
                        "Price": 0.0006,
                        "UnitCode": "CNY/1KToken",
                        "Type": "CompletionToken"
                    }
                ],
                "MultiChargeItems": [],
                "FreeResourcePackItems": [],
                "SubServices": [
                    {
                        "SubService": "Inference",
                        "Status": "Unavailable"
                    }
                ],
                "IsOverdue": false,
                "IsLimitedActivation": false,
                "IsDeprecated": false
            }
        ]
    }
}
```