DescribeResourcePackage - 获取已购资源包详情--内容分发网络-火山引擎

文档中心

立即注册

导航

DescribeResourcePackage - 获取已购资源包详情

最近更新时间：2025.10.28 18:03:03首次发布时间：2025.05.15 20:34:28

获取您账号下符合查询条件的所有已购资源包的详情。

使用限制

节流限制：您每秒最多可以提交 20 个 API 请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=DescribeResourcePackage&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeResourcePackage`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
PageNum	Long	否	表示分页号。响应正文中仅包含属于该分页的资源包信息。该参数的默认值是 0，表示获取所有符合查询条件的资源包。	`1`
PageSize	Long	否	表示每个分页包含的资源包数量。该参数的默认值是 0，表示不对获取的资源包列表进行分页。	`10`
SortBy	String	否	表示返回的资源包列表基于哪个字段排序。该参数有以下取值： `StartTime`：表示资源包的生效时间。 `EndTime`：表示资源包的过期时间。该参数的默认值是 `StartTime`。	`StartTime`
SortDirection	String	否	表示排序顺序。该参数有以下取值： `asc`：表示升序排序。 `desc`：表示降序排序。该参数的默认值是 `asc`。	`desc`
Status	String	否	表示资源包的一个状态，以获取该状态下的资源包。该参数有以下取值： `valid`：表示生效中。 `expired`：表示已过期。 `finished`：表示资源包的额度已用完。 `unsubscribed`：表示已退订。 `recycled`：表示已回收。资源包过期后会被系统回收。 `ineffective`：表示未生效。如果该参数不指定，表示不指定该查询条件。	`valid`
ValidityPeriod	String	否	表示一个有效时长，以获取具有该有效时长的资源包。该参数有以下取值： `one_month`：表示 1 个月。 `six_month`：表示 6 个月. `twelve_month`：表示 12 个月。如果该参数不指定，表示不指定该查询条件。	`twelve_month`
PackType	String	否	表示资源包的类型。该参数有以下取值： `all`：表示所有类型的资源包。 `TrafficPackage`：表示所有类型的流量包。 `ChineseMainlandTrafficPackage`：表示适用于中国内地流量包。 `OverSeaTrafficPackage`：表示适用于中国内地以外区域的流量包。 `TlsRequestPackage`：表示实时日志投递数资源包。 `QuicRequestPackage`：表示 QUIC 请求数资源包。如果该参数不指定，表示不指定该查询条件。	`ChineseMainlandTrafficPackage`

返回参数

参数名称	数据类型	参数说明	示例
Packages	Object[]	表示符合查询条件的资源包列表。
PageNum	Long	表示您在请求参数中指定的 `PageNum`。	`1`
PageSize	Long	表示您在请求参数中指定的 `PageSize`。	`10`
Total	Long	表示符合查询条件的资源包数量。	`48`

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeResourcePackage&Version=2021-03-01
{
    "PageNum": 1,
    "PageSize": 2,
    "Status": "valid",
    "ValidityPeriod": "one_month",
    "SortBy": "StartTime",
    "SortDirection": "desc"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202505141825321AD72BF9A407298AEB19",
        "Action": "DescribeResourcePackage",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "Packages": [
            {
                "AvailableAmount": 100,
                "Category": "CDN/DCDN资源包",
                "ConfigurationCode": "TrafficPackage_inner_100GB_1M",
                "DeductionTime": 1733834616,
                "EndTime": 1733834616,
                "InstanceNo": "CDN/DCDNC21000034642024121020425772230950",
                "PackageName": "CDN/DCDN-100GB-1个月有效期",
                "Product": "CDN/DCDN",
                "ServiceRegion": "chinese_mainland",
                "StartTime": 1733834585,
                "Status": "valid",
                "TotalAmount": 100,
                "ValidityPeriod": "one_month"
            },
            {
                "AvailableAmount": 79.878585369,
                "Category": "CDN资源包",
                "ConfigurationCode": "CDN_overseas_100GB_package",
                "DeductionTime": 1756737058,
                "EndTime": 1785340799,
                "InstanceNo": "CDN2000000300965516034",
                "PackageName": "CDN海外流量包-100GB",
                "Product": "CDN",
                "ServiceRegion": "outside_chinese_mainland",
                "StartTime": 1753718908,
                "Status": "valid",
                "TotalAmount": 100,
                "ValidityPeriod": "twelve_month"
            }
        ],
        "PageNum": 1,
        "PageSize": 2,
        "Total": 48
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。