# 查询模型开通详情

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

`POST https://ark.cn-beijing.volcengineapi.com/?Action=GetModelActivation&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` `必选` | 基础模型名称

要查询开通详情的基础模型名称。

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

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

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

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

## 响应参数

**Item** `object` | 模型激活详情

指定基础模型的激活详情。

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

`Item.ChargeItems`

模型的计费项列表。

**Price** `number` | 单价

`Item.ChargeItems.Price`

计费项的单价。

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

`Item.ChargeItems.Type`

计费项的类型标识。

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

`Item.ChargeItems.UnitCode`

计费项的计量单位编码。

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

`Item.ChargeItems.DiscountPriceEndTime`

折扣价格的结束时间。

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

`Item.ChargeItems.DiscountPriceStartTime`

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

**OriginalPrice** `number` | 原价

`Item.ChargeItems.OriginalPrice`

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

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

`Item.DisplayName`

模型的展示名称。

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

`Item.FoundationModelName`

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

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

`Item.FreeResourcePackItems`

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

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

`Item.FreeResourcePackItems.Consumed`

资源包中已消耗的数量。

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

`Item.FreeResourcePackItems.Reclaimed`

资源包中已回收的数量。

**Total** `integer` | 总量

`Item.FreeResourcePackItems.Total`

资源包的总量。

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

`Item.FreeResourcePackItems.Type`

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

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

`Item.FreeResourcePackItems.SyncTime`

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

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

`Item.MultiChargeItems`

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

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

`Item.MultiChargeItems.ChargeItems`

该档位下的计费项列表。

**Price** `number` | 单价

`Item.MultiChargeItems.ChargeItems.Price`

计费项的单价。

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

`Item.MultiChargeItems.ChargeItems.Type`

计费项的类型标识。

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

`Item.MultiChargeItems.ChargeItems.UnitCode`

计费项的计量单位编码。

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

`Item.MultiChargeItems.ChargeItems.DiscountPriceEndTime`

折扣价格的结束时间。

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

`Item.MultiChargeItems.ChargeItems.DiscountPriceStartTime`

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

**OriginalPrice** `number` | 原价

`Item.MultiChargeItems.ChargeItems.OriginalPrice`

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

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

`Item.MultiChargeItems.Description`

该计费档位的描述说明。

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

`Item.MultiChargeItems.MaxCompletionTokens`

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

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

`Item.MultiChargeItems.MaxPromptTokens`

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

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

`Item.MultiChargeItems.Name`

该计费档位的名称。

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

`Item.State`

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

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

`Item.SubServices`

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

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

`Item.SubServices.Status`

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

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

`Item.SubServices.SubService`

子服务的类型标识。

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

`Item.VendorName`

模型所属厂商的名称。

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

`Item.InitialInferenceFreeUsage`

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

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

`Item.InitialInferenceFreeUsage.Consumed`

已消耗的免费推理额度。

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

`Item.InitialInferenceFreeUsage.Total`

免费推理的总额度。

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

`Item.Instruction`

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

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

`Item.IsDeprecated`

模型是否已下线。

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

`Item.IsLimitedActivation`

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

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

`Item.IsOverdue`

模型是否处于逾期状态。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=GetModelActivation&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",
    "WithPrice": true,
    "WithFreeUsage": true
}
'
```

#### Response

```
{
    "ResponseMetadata": {
        "RequestId": "20240514212753D4E5F607182D03CEF7",
        "Action": "GetModelActivation",
        "Version": "2024-01-01",
        "Service": "ark",
        "Region": "cn-beijing"
    },
    "Result": {
        "Item": {
            "FoundationModelName": "doubao-seed-2-0-pro",
            "State": "Available",
            "VendorName": "火山方舟",
            "DisplayName": "Doubao Seed 2.0 Pro",
            "ChargeItems": [
                {
                    "Price": 0.0008,
                    "UnitCode": "CNY/1KToken",
                    "Type": "PromptToken",
                    "OriginalPrice": 0.0012,
                    "DiscountPriceStartTime": "2024-04-01T00:00:00Z",
                    "DiscountPriceEndTime": "2024-12-31T23:59:59Z"
                },
                {
                    "Price": 0.002,
                    "UnitCode": "CNY/1KToken",
                    "Type": "CompletionToken",
                    "OriginalPrice": 0.003,
                    "DiscountPriceStartTime": "2024-04-01T00:00:00Z",
                    "DiscountPriceEndTime": "2024-12-31T23:59:59Z"
                }
            ],
            "MultiChargeItems": [
                {
                    "Name": "0-32K",
                    "Description": "输入 Token 数不超过 32K 时适用的计费档位",
                    "MaxPromptTokens": 32768,
                    "MaxCompletionTokens": 4096,
                    "ChargeItems": [
                        {
                            "Price": 0.0008,
                            "UnitCode": "CNY/1KToken",
                            "Type": "PromptToken"
                        },
                        {
                            "Price": 0.002,
                            "UnitCode": "CNY/1KToken",
                            "Type": "CompletionToken"
                        }
                    ]
                }
            ],
            "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"
                },
                {
                    "SubService": "Finetune",
                    "Status": "Available"
                }
            ],
            "Instruction": "开通后即可通过推理接入点调用该模型。",
            "IsOverdue": false,
            "IsLimitedActivation": false,
            "IsDeprecated": false
        }
    }
}
```
