Domain name for API request: tdmysql.intl.tencentcloudapi.com.
This API is used to query instance list.
A maximum of 200 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: DescribeDBInstances. |
| Version | Yes | String | Common Params. The value used for this API: 2021-11-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Filters.N | No | Array of InstanceFilter | Filter parameters. |
| Limit | No | Integer | Maximum return count, defaults to 20, maximum 100 |
| Offset | No | Integer | Offset, which is an integer multiple of Limit. |
| Parameter Name | Type | Description |
|---|---|---|
| Instances | Array of InstanceInfo | Return the instance list information |
| TotalCount | Integer | Total number of conditions met |
| 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: tdmysql.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstances
<Common request parameters>
{
"Filters": [
{
"Name": "Status",
"Values": [
"creating",
"running"
]
},
{
"Name": "VpcId",
"Values": [
"vpc-asdfifff"
]
}
],
"Limit": 20,
"Offset": 0
}
{
"Response": {
"Instances": [
{
"ComputeNodeNum": 2,
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-1",
"CreateVersion": "RELEASE_R080D001",
"InitParams": [
{
"Value": "lower_case_table_names",
"Param": "0"
}
],
"Status": "running",
"StatusDesc": "Running"
"InstanceId": "tdsql3-f3475547",
"StorageNodeNum": 3,
"ResourceTags": [
{
"TagKey": "tag-key",
"TagValue": "tag-value"
}
],
"InstanceName": "tdsql3-f3475547",
"Cpu": 4,
"VpcId": "vpc-o7ssr1vx",
"Mem": 8,
"Vip": "172.16.113.202",
"SubnetId": "subnet-s21doiba",
"Vport": 6008,
"Disk": 200,
"CreateTime": "2006-01-02 15:04:05"
}
],
"RequestId": "a93d2900-ef72-11eb-ab93-0716f253da76",
"TotalCount": 100
}
}
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 |
|---|---|
| AuthFailure.UnauthorizedOperation | CAM authentication failure. |
| FailedOperation.DBQueryInstanceError | Query instance data failed. |
| FailedOperation.DBQueryTagError | Failed to query instance data bound to tags. |
| InvalidParameterValue.InstanceFilterKeyError | Filter parameter error in the instance. |
| LimitExceeded.OutOfInstanceCountLimitError | The count of pull instances exceeds the limit. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback