Domain name for API request: cynosdb.tencentcloudapi.com.
This API is used to query the list of resources by billing order ID.
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: DescribeResourcesByDealName. |
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. |
DealName | No | String | Order ID. (If the cluster is not delivered yet, the DescribeResourcesByDealName API may return the InvalidParameterValue.DealNameNotFound error. Call the API again until it succeeds.) |
DealNames.N | No | Array of String | Order ID, which can be used to query the resource information of multiple orders ID (If the cluster is not delivered yet, the DescribeResourcesByDealName API may return the InvalidParameterValue.DealNameNotFound error. Call the API again until it succeeds.) |
Parameter Name | Type | Description |
---|---|---|
BillingResourceInfos | Array of BillingResourceInfo | Billable resource ID information array |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourcesByDealName
<Common request parameters>
{
"DealName": "xxx"
}
{
"Response": {
"BillingResourceInfos": [
{
"ClusterId": "cynosdbmysql-r8ewihg4",
"InstanceIds": [
"cynosdbmysql-ins-pecl0drs"
],
"DealName": "xxx"
},
{
"ClusterId": "cynosdbmysql-hjosrxhu",
"InstanceIds": [
"cynosdbmysql-ins-7f59pahg"
],
"DealName": "xxx"
}
],
"RequestId": "005b862f-f408-4a95-a7e7-26f3e672e081"
}
}
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. |
InternalError.DbOperationFailed | Failed to query the database. |
InternalError.SystemError | Internal system error. |
InvalidParameterValue.DealNameNotFound | No order ID found. |
InvalidParameterValue.ParamError | Incorrect parameter. |
InvalidParameterValue.ParameterOutRangeError | Invalid parameter value |
OperationDenied.InstanceAccessDeniedError | You do not have the permission to operate this resource. |
UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Was this page helpful?