Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to query order associated instances.
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. 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. |
| DealName | No | String | Billing order ID (if billing has not called back business delivery, the error code InvalidParameterValue.DealNameNotFound may occur. In this case, the business needs to retry the DescribeResourcesByDealName API until it succeeds). Enter at least one of DealName and DealNames. If both are entered, DealName takes precedence. |
| DealNames.N | No | Array of String | List of billing order IDs. You can query the resource information for several order IDs in a single query. If billing has not yet called back the business for delivery, the error code InvalidParameterValue.DealNameNotFound may occur. In this case, retry the DescribeResourcesByDealName API until it succeeds. Enter at least one of DealName and DealNames. If both are entered, DealName takes precedence. |
| Parameter Name | Type | Description |
|---|---|---|
| BillingResourceInfos | Array of BillingResourceInfo | Billing resource id information array |
| 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. |
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourcesByDealName
<Common request parameters>
{
"DealName": "201302542054"
}{
"Response": {
"BillingResourceInfos": [
{
"ClusterId": "cynosdbmysql-r8ewihg4",
"InstanceIds": [
"cynosdbmysql-ins-pecl0drs"
],
"DealName": "201302542054"
},
{
"ClusterId": "cynosdbmysql-hjosrxhu",
"InstanceIds": [
"cynosdbmysql-ins-7f59pahg"
],
"DealName": "201302542054"
}
],
"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 | Database access failed. Try again later. If the issue persists, contact customer service. |
| InternalError.DbOperationFailed | Query database failed. |
| InternalError.SystemError | Internal system error. |
| InvalidParameterValue.DealNameNotFound | Order id not found. |
| InvalidParameterValue.ParamError | Parameter error. |
| InvalidParameterValue.ParameterOutRangeError | Invalid parameter value. The value exceeds the maximum allowed. |
| OperationDenied.InstanceAccessDeniedError | You do not have permission to operate the resource. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
文档反馈