1. API Description
Domain name for API request: dcdb.intl.tencentcloudapi.com.
This API is used to query TDSQL order information. You can pass in an order ID to query the TDSQL instance associated with the order and the corresponding task process ID.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: DescribeOrders. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2018-04-11. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| DealNames.N |
Yes |
Array of String |
List of long order IDs to be queried, which are returned by the APIs for creating, renewing, or scaling instances. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TotalCount |
Integer |
Returned number of orders |
| Deals |
Array of Deal |
Order information list |
| 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. |
4. Example
https:
&DealNames.0=20181103110163
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "9b59ee51-0e13-1c2f-dedb-59fabe9d7f4a",
"TotalCount": 1,
"Deals": [
{
"DealName": "20181103110163",
"OwnerUin": "1235674890",
"Count": 1,
"PayMode": 1,
"FlowId": 1234,
"InstanceIds": [
"dcdbt-avw0207d"
]
}
]
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| InternalError.CamAuthFailed |
CAM authentication request failed. |
| InternalError.QueryOrderFailed |
Failed to query the order information. |
| InvalidParameter.DealNameNotGiven |
The order ID to be queried is not specified. |
| InvalidParameter.GenericParameterError |
An error occurred while verifying parameter validity. |
| UnauthorizedOperation.PermissionDenied |
You have no permission to manipulate this API or resource. |