面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/list-resource-activations-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

查询资源开通列表

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

列出当前账号视角下资源的开通状态,支持按资源类型、资源名称和状态筛选,可选附带价格与免费资源包信息。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。

请求参数#

Body 参数#

Filter object 必选  |  筛选条件

资源开通列表的筛选条件,可按资源类型、资源名称和开通状态过滤。

ResourceType string 必选  |  资源类型

Filter.ResourceType

按资源类型筛选。

ResourceNames string[]  |  资源名称列表

Filter.ResourceNames

按资源名称列表筛选,命中其中任一名称的资源均会返回。

States string[]  |  状态筛选

Filter.States

按资源开通状态筛选。取值 Available 表示已开通、Unavailable 表示未开通。

PageNumber integer 默认值 1  |  起始页码

分页查询时的起始页码。

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

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

SortBy string  |  排序字段

排序所依据的字段名。默认值:ResourceName

SortOrder string 默认值 Desc  |  排序顺序

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

WithFreeResourcePack boolean  |  是否附带资源包信息

是否在返回结果中附带资源的免费资源包信息。

WithPrice boolean  |  是否附带价格信息

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

响应参数#

Items object[]  |  资源开通列表

资源开通条目列表。每个元素包含一个资源的开通状态、价格和免费资源包信息。

ChargeItems object[]  |  计费项列表

Items.ChargeItems

资源关联的计费项列表。当 WithPrice 为 false 时,返回空数组。

Price number  |  单价

Items.ChargeItems.Price

计费项的单价。

Type string  |  计费项类型

Items.ChargeItems.Type

计费项的类型标识。

UnitCode string  |  计量单位编码

Items.ChargeItems.UnitCode

计费项的计量单位编码。

DiscountPriceEndTime string  |  折扣结束时间

Items.ChargeItems.DiscountPriceEndTime

折扣价格的结束时间,格式遵循 RFC3339。

DiscountPriceStartTime string  |  折扣开始时间

Items.ChargeItems.DiscountPriceStartTime

折扣价格的生效起始时间,格式遵循 RFC3339。

OriginalPrice number  |  原价

Items.ChargeItems.OriginalPrice

计费项的原始价格(折扣前)。

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

Items.FreeResourcePackItems

资源关联的免费资源包列表。当 WithFreeResourcePack 为 false 时,返回空数组。

Consumed number  |  已消耗量

Items.FreeResourcePackItems.Consumed

免费资源包中已消耗的数量。

Reclaimed number  |  已回收量

Items.FreeResourcePackItems.Reclaimed

免费资源包中已回收的数量。

ResourceName string  |  资源名称

Items.FreeResourcePackItems.ResourceName

免费资源包对应的资源名称。

Total integer  |  总量

Items.FreeResourcePackItems.Total

免费资源包的总量。

Type string  |  资源包类型

Items.FreeResourcePackItems.Type

免费资源包类型,取值固定为 FreeResourcePack。

SyncTime string  |  同步时间

Items.FreeResourcePackItems.SyncTime

免费资源包数据的最近同步时间,格式遵循 RFC3339。

ResourceName string  |  资源名称

Items.ResourceName

资源的名称标识。

ResourceType string  |  资源类型

Items.ResourceType

资源所属的类型。

State string  |  开通状态

Items.State

资源的开通状态。取值 Available 表示已开通、Unavailable 表示未开通。

IsLimitedActivation boolean  |  是否限量开通

Items.IsLimitedActivation

资源是否为限量开通。

PageNumber integer  |  当前页码

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

PageSize integer  |  每页记录数

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

TotalCount integer  |  总数

符合筛选条件的资源开通记录总数。