You need to enable JavaScript to run this app.
RDS for MySQL

RDS for MySQL

  • Documentation
    • RDS for MySQLAPI referenceV2（2022-01-01）Resource plan managementDescribeResourcePackageDetail
Copy page
Download PDF
Resource plan management
DescribeResourcePackageDetail
Copy page
Download PDF
DescribeResourcePackageDetail

Call the DescribeResourcePackageDetail interface to query the detailed usage information of the resource package.

Request type

Synchronous request.

Request parameters

Name
Type
Required
Example
Description
PackageId
String
Yes
rds-pkg-210000****-4e1f
The ID of the resource package.
QueryStartTime
String
Yes
2025-09-21T16:00:00Z
The start time of the specified time period (UTC time). The format is yyyy-MM-ddTHH:mm:ssZ.
QueryEndTime
String
Yes
2025-09-28T15:59:59Z
The end time of the specified time period (UTC time). The format is yyyy-MM-ddTHH:mm:ssZ.
PageNumber
Integer
No
1
The page number of the current page. The minimum value is 1. The default value is 1.
PageSize
Integer
No
10
The number of records per page. The minimum value is 1, and the maximum value does not exceed 1000. The default value is 10.

Response parameters

Name
Type
Example
Description
ResourcePackage
Object
Please refer to the return example.
Detailed information of the resource package.
Region
String
cn-beijign
The region to which the resource package belongs.
PackageId
String
rds-pkg-210000****-ec95
The ID of the resource package.
CreateTime
String
2025-08-26T06:51:19.000Z
The creation time of the resource package (UTC time). The format is yyyy-MM-ddTHH:mm:ss.sssZ.
PackageSpec
String
100
The specifications of the resource package.
PackageType
String
StoragePackage
The type of the resource package. Currently, only the value StoragePackage is supported, which means a storage package.
EffectiveTime
String
2025-09-30T14:00:00.000Z
The effective time of the resource package (UTC time). The format is yyyy-MM-ddTHH:mm:ss.sssZ.
PackageStatus
String
NotEffective

The status of the resource package. Values:

  • NotEffective: Not effective.
  • InUse: In use.
  • Expire: Expired.
ExpirationTime
String
2025-10-30T15:59:59.000Z
The expiration time of the resource package (in UTC time). The format is yyyy-MM-ddTHH:mm:ss.sssZ.
PurchaseDuration
Integer
1
The purchase duration of the resource package. The unit is month.
UsageProgress
Integer
89
The usage progress of the resource package. The unit is percentage.
UsageItems
Object[]
Please refer to the return example.
Usage details of the resource package.
UsageRatio
Double
Usage rate
DeductionItem
String
Deduction item name
DeductionTimeEnd
String
Deduction end time
DeductionTimeStart
String
Deduction start time
Total
Integer
3
The quantity of the usage details of the resource package.

Sample request 

POST /?Action=DescribeResourcePackageDetail&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****
{
    "PackageId": "rds-pkg-210000****-4e1f",
    "QueryStartTime": "2025-09-21T16:00:00Z",
    "QueryEndTime": "2025-09-28T15:59:59Z",
    "PageNumber": 1,
    "PageSize": 10
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "20250923112134D0FDC5B835A79FF44B47-2f9056",
        "Action": "DescribeResourcePackageDetail",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "ResourcePackage": {
            "CreateTime": "2025-08-26T06:51:19.000Z",
            "EffectiveTime": "2025-08-26T06:00:00.000Z",
            "ExpirationTime": "2025-09-26T15:59:59.000Z",
            "PackageId": "rds-pkg-2100000746-b4e7",
            "PackageSpec": "100",
            "PackageStatus": "InUse",
            "PackageType": "StoragePackage",
            "PurchaseDuration": 1,
            "Region": "cn-beijing"
        },
        "Total": 0,
        "UsageItems": null,
        "UsageProgress": 89
    }
}

Error codes

For more details, refer to Error codes.

Last updated: 2025.12.08 15:47:13