Domain name for API request: cynosdb.tencentcloudapi.com.
This API is used to query the list of the resource packs.
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. |
PackageId.N | No | Array of String | The unique ID of a resource pack |
PackageName.N | No | Array of String | Resource pack name |
PackageType.N | No | Array of String | Resource pack type. Valid values: CCU (compute resource pack), DISK (storage resource pack). |
PackageRegion.N | No | Array of String | Region of the resource pack. Valid values: China (Chinese mainland), overseas (outside Chinese mainland). |
Status.N | No | Array of String | Resource pack status. Valid values: using , expired , normal_finish (used up), apply_refund (requesting a refund), refund (refunded). |
OrderBy.N | No | Array of String | Sorting conditions. Valid values: startTime (effective time), expireTime (expiration date), packageUsedSpec (used capacity), packageTotalSpec (total storage capacity). Sorting by array order |
OrderDirection | No | String | Sorting order. Valid values: ASC (ascending), DESC (descending). |
Offset | No | Integer | Offset |
Limit | No | Integer | Limit |
Parameter Name | Type | Description |
---|---|---|
Total | Integer | Total number of resource packs |
Detail | Array of Package | Resource pack details Note: This field may return null, indicating that no valid values can be obtained. |
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. |
This example shows you how to query the list of the resource packs.
POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeSourcePackageList<common request parameters>{ "PackageId": [ "abc" ], "PackageName": [ "abc" ], "PackageType": [ "abc" ], "PackageRegion": [ "abc" ], "Status": [ "abc" ], "OrderBy": [ "abc" ], "OrderDirection": "abc", "Offset": 0, "Limit": 0}
{
"Response": {
"Total": 0,
"Detail": [
{
"AppId": 0,
"PackageId": "abc",
"PackageName": "abc",
"PackageType": "abc",
"PackageRegion": "abc",
"Status": "abc",
"PackageTotalSpec": 0,
"PackageUsedSpec": 0,
"HasQuota": true,
"BindInstanceInfos": [
{
"InstanceId": "abc",
"InstanceRegion": "abc",
"InstanceType": "abc"
}
],
"StartTime": "abc",
"ExpireTime": "abc"
}
],
"RequestId": "abc"
}
}
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 | Failed to access the database. Please try again later. If the problem persists, please contact customer service. |
FailedOperation.QuerySourcePackageError | Failed to query the resource pack |
InternalError.DbOperationFailed | Failed to query the database. |
InternalError.SystemError | Internal system error. |
InvalidParameterValue.InvalidParameterValueError | Invalid parameter value. |
UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Was this page helpful?