ListResourcePackages--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

ListResourcePackages

最近更新时间：2025.12.08 14:51:13首次发布时间：2025.12.08 14:51:13

调用 ListResourcePackages 接口查询资源包列表。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
EffectiveTime	Object	否	{ "EndTime":"2025-08-20T08:00:00.000Z", "StartTime":"2025-08-20T08:00:00.000Z" }	通过资源包的生效时间段查询。
ExpirationTime	Object	否	{ "EndTime":"2029-08-20T08:00:00.000Z", "StartTime":"2026-08-20T08:00:00.000Z" }	通过资源包的到期时间段查询。
PackageStatus	String	否	NotEffective	资源包的状态。取值： `NotEffective`：未生效。 `InUse`：使用中。 `Expire`：已过期。
PackageType	String	否	StoragePackage	资源包的类型。当前仅支持取值为 `StoragePackage`，即存储包。
PackageSpec	String	否	100	资源包规格。如 PackageType 取值为 StoragePackage，则 PackageSpec 的取值范围为： `100`：100 GiB。 `200`：200 GiB。 `300`：300 GiB。 `500`：500 GiB。 `1000`：1000 GiB。 `2000`：2000 GiB。 `5000`：5000 GiB。 `10000`：10000 GiB。
PurchaseDuration	Integer	否	1	资源包的购买时长。
PageNumber	Integer	否	1	当前页页码。取值最小为 1。默认值为 1。
PageSize	Integer	否	20	每页记录数。最小值为 1，最大值不超过 1000。默认值为 10。
OrderType	String	否	asc	查询结果的排序方式。取值： `asc`：升序排序。 `desc`：降序排序。默认值。
OrderBy	String	否	ExpirationTime	用于排序的字段。取值： `EffectiveTime`：资源包的生效时间。默认值。 `ExpirationTime`：资源包的到期时间。

返回参数

参数	类型	示例值	描述
Total	Integer	21	符合查询条件的结果数量。
ResourcePackages	Object[]	请参见返回示例。	资源包的详细信息。

示例

请求示例

POST /?Action=ListResourcePackages&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "ExpirationTime": {
        "EndTime": "2029-08-20T08:00:00.000Z",
        "StartTime": "2026-08-20T08:00:00.000Z"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250922223137889D767ED5A0B1FEB66D-35b4e1",
        "Action": "ListResourcePackages",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "ResourcePackages": [
            {
                "CreateTime": "2025-08-19T08:22:15.000Z",
                "EffectiveTime": "2025-08-20T08:00:00.000Z",
                "ExpirationTime": "2028-08-20T15:59:59.000Z",
                "PackageId": "rds-pkg-210000****-4e1f",
                "PackageSpec": "100",
                "PackageStatus": "InUse",
                "PackageType": "StoragePackage",
                "PurchaseDuration": 36,
                "Region": "cn-beijing"
            },
            {
                "CreateTime": "2025-08-19T08:22:15.000Z",
                "EffectiveTime": "2025-08-20T08:00:00.000Z",
                "ExpirationTime": "2028-08-20T15:59:59.000Z",
                "PackageId": "rds-pkg-210000****-24f5",
                "PackageSpec": "100",
                "PackageStatus": "InUse",
                "PackageType": "StoragePackage",
                "PurchaseDuration": 36,
                "Region": "cn-beijing"
            }
        ],
        "Total": 2
    }
}

错误码

更多详情，请参见错误码。