Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to query the resource package list.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeResourcePackageList. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| PackageId.N | No | Array of String | Unique ID of the resource package |
| PackageName.N | No | Array of String | Resource package name. |
| PackageType.N | No | Array of String | Resource package type CCU: compute resource package. DISK: storage resource package. |
| PackageRegion.N | No | Array of String | Region of use for the resource package china: common in the Chinese mainland; overseas: common in Hong Kong (China), Macao (China), Taiwan (China), and overseas regions |
| Status.N | No | Array of String | Resource pack status creating using: in use; expired normal_finish: used up; apply_refund: refund requested. refund: refunded. |
| OrderBy.N | No | Array of String | Sort condition. Supported sort condition: startTime - effective time. expireTime: expiration time, packageUsedSpec: used capacity, packageTotalSpec: total storage capacity. Sequential arrangement by array. |
| OrderDirection | No | String | Sorting method. DESC: descending order. ASC: ascending order. |
| Offset | No | Integer | Offset. |
| Limit | No | Integer | Limit |
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total number of resource packages. |
| Detail | Array of Package | Resource pack details |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Inquire about the resource package list
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSourcePackageList
<Common request parameters>
{
"PackageId": [
"package-bst68sh3"
],
"PackageName": [
"Custom resource package name-1"
],
"PackageType": [
"CCU"
],
"PackageRegion": [
"chineseMainland"
],
"Status": [
"using"
],
"OrderBy": [
"createTime"
],
"OrderDirection": "desc",
"Offset": 0,
"Limit": 20
}{
"Response": {
"Total": 20,
"Detail": [
{
"AppId": 12387234,
"PackageId": "package-cbhsyegx",
"PackageName": "MyPackageName",
"PackageType": "CCU",
"PackageRegion": "chineseMainland",
"Status": "using",
"PackageTotalSpec": 10000000,
"PackageUsedSpec": 2394.3,
"HasQuota": true,
"BindInstanceInfos": [
{
"InstanceId": "cynosdbpg-ins-bzkxxrmt",
"InstanceRegion": "ap-guangzhou",
"InstanceType": "cynosdb-serverless"
}
],
"StartTime": "2023-12-10 00:00:00",
"ExpireTime": "2025-11-10 00:00:00",
"PackageVersion": "common"
}
],
"RequestId": "e0c28bb4-a0f2-4194-a646-b8bcf777b5ce"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.DatabaseAccessError | Database access failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.QuerySourcePackageError | Failed to query the resource package |
| InternalError.DbOperationFailed | Query database failed. |
| InternalError.SystemError | Internal system error. |
| InvalidParameterValue.InvalidParameterValueError | Parameter value is invalid. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
フィードバック