POST https://ark.cn-beijing.volcengineapi.com/?Action=ListModelPrices&Version=2024-01-01
查询当前账号可见基础模型的价格信息,可按服务类型、窗口、区域、时段、分辨率和输出尺寸筛选价格分组。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
FoundationModelNames string[] 必选 | 基础模型列表
待查询价格的基础模型名称列表。重复名称仅查询一次,并按去重后的请求顺序返回结果。
Dimensions object[] | 价格维度筛选
按服务类型、窗口、区域、时段、分辨率和输出尺寸筛选价格分组。未指定 service_type 时,返回空的模型价格列表。
Name string 必选 | 维度名称
Dimensions.Name
价格筛选维度名称。可选值:service_type(服务类型)、window(窗口)、region(区域)、time_period_type(时段类型)、resolution(分辨率)、output_size_level(输出尺寸级别)。
Values string[] 必选 | 维度取值
Dimensions.Values
与 Dimensions.Name 对应的筛选值,具体对应关系见下表。
| 维度名称 | 取值 | 查询规则 |
|---|---|---|
service_type |
|
必须指定。仅返回指定服务类型对应的价格分组。 |
window |
模型实际返回的完整窗口档位字符串,包括以下形式:
字符串中的中文逗号、大小写以及 ≤、<= 等符号均按实际返回值保留。 |
请求时传入与响应中 window.Value 完全一致的档位字符串,不得转换或改写取值格式。Values 支持传入一个或多个完整档位值,多个取值按“或”匹配。未指定 window 时,返回符合其他筛选条件的全部窗口档位;指定 window 时,仅返回与传入值匹配的窗口档位。 |
region |
|
未指定时仅返回默认全局档位;指定区域值时仅返回对应区域档位;同时指定 "" 和区域值时,返回默认全局档位及指定区域档位。 |
time_period_type |
|
未指定时返回常规/忙时档;指定 offpeak 时仅返回闲时档;同时指定 "" 和 offpeak 时,返回常规/忙时档及闲时档。 |
resolution |
|
未指定时返回默认分辨率档位;指定分辨率值时仅返回对应档位;同时指定 "" 和分辨率值时,返回默认分辨率档位及指定分辨率档位。 |
output_size_level |
|
未指定时返回默认尺寸档位;指定尺寸值时仅返回对应档位;同时指定 "" 和尺寸值时,返回默认尺寸档位及指定尺寸档位。 |
响应参数#
ModelPrices object[] | 模型价格列表
当前账号可见模型的价格列表。
FoundationModelName string | 基础模型名称
ModelPrices.FoundationModelName
PriceGroups object[] | 价格分组
ModelPrices.PriceGroups
基础模型在不同计费条件下对应的价格分组。
Dimensions object[] | 价格维度
ModelPrices.PriceGroups.Dimensions
价格分组中显式配置的维度组合。默认档位对应的维度不包含在此数组中。
Name string | 维度名称
ModelPrices.PriceGroups.Dimensions.Name
价格分组中显式配置的维度名称。可选值:service_type、window、region、time_period_type、resolution、output_size_level。
Value string | 维度取值
ModelPrices.PriceGroups.Dimensions.Value
价格分组中该维度的实际取值。
PriceItems object[] | 计费项价格
ModelPrices.PriceGroups.PriceItems
价格分组中的计费项价格信息。
Label string | 计费项名称
ModelPrices.PriceGroups.PriceItems.Label
计费项名称。仅返回当前模型适用的计费项。
以下为常见计费项,非完整枚举,具体以模型实际返回的计费项为准。
Prompt:输入 Token。Completion:输出 Token。CacheHit:缓存命中 Token。Storage:缓存存储。ToICompletion:图像生成输出。T2VCompletion:视频生成输出。
PriceUnitCode string | 价格单位编码
ModelPrices.PriceGroups.PriceItems.PriceUnitCode
价格计量单位的编码。
DiscountPriceEndTime string | 促销结束时间
ModelPrices.PriceGroups.PriceItems.DiscountPriceEndTime
促销价格的失效时间,格式为 RFC3339。
DiscountPriceStartTime string | 促销开始时间
ModelPrices.PriceGroups.PriceItems.DiscountPriceStartTime
促销价格的生效时间,格式为 RFC3339。
OriginalPrice number | 原价
ModelPrices.PriceGroups.PriceItems.OriginalPrice
折扣前价格。
Price number | 当前价格
ModelPrices.PriceGroups.PriceItems.Price
当前账号对应的价格。
UsageUnit string | 用量单位
ModelPrices.PriceGroups.UsageUnit
价格分组使用的用量单位。
DimensionAttributes object[] | 匹配的维度附属信息
ModelPrices.DimensionAttributes
与当前模型价格匹配的维度附属信息。
Name string | 维度名称
ModelPrices.DimensionAttributes.Name
维度附属信息的名称。可选值:service_type、window、region、time_period_type、resolution、output_size_level。
Value string | 维度取值
ModelPrices.DimensionAttributes.Value
维度附属信息的取值。
Ranges string[] | 维度范围
ModelPrices.DimensionAttributes.Ranges
与维度取值关联的范围信息。闲时时段的取值可能为包含星期、起始时间、结束时间和时区等信息的 JSON 字符串,具体内容以实际返回值为准。