Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query cloud disk edition instance info.
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: DescribeClusterInfo. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID, which can be obtained through the DescribeDBInstances API. Description: Only able to input the instance ID of instances with cloud disk architecture, corresponding to console instance configurations displayed as "Cloud Disk Edition (Cloud Disk)". |
| Parameter Name | Type | Description |
|---|---|---|
| ClusterName | String | Instance name. |
| ReadWriteAddress | AddressInfo | Address information for reading and writing of the cloud disk edition instance. |
| ReadOnlyAddress | Array of AddressInfo | Read-only address information of the cloud disk edition instance. |
| NodeList | Array of ClusterNodeInfo | Node list information of the Cloud Disk Edition instance. |
| ReadonlyLimit | Integer | Read-only space protection threshold, GB |
| NodeCount | Integer | Number of instance nodes. |
| 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: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterInfo
<Common request parameters>
{
"InstanceId": "cdb-dctw4edd"
}
{
"Response": {
"ClusterName": "dbname",
"ReadWriteAddress": {
"ResourceId": "cdb-dctw4edd",
"UniqVpcId": "vpc-hendkj",
"UniqSubnetId": "subnet-eushjw",
"Vip": "192.168.3.4",
"VPort": 3306,
"WanDomain": "gz-cdb-*******.sql.tencentcdb.com",
"WanPort": 23356
},
"ReadOnlyAddress": [
{
"ResourceId": "cdbro-3a1eccdd",
"UniqVpcId": "vpc-ehndjs",
"UniqSubnetId": "subnet-euwhsn",
"Vip": "192.168.3.5",
"VPort": 3306,
"WanDomain": "gz-cdb-*******.sql.tencentcdb.com",
"WanPort": 23356
}
],
"NodeList": [
{
"NodeId": "dbn-qqeo1111",
"Role": "master",
"Zone": "ap-guangzhou-1",
"Weight": 1,
"Status": "online"
},
{
"NodeId": "dbn-qqeo2222",
"Role": "slave",
"Zone": "ap-guangzhou-2",
"Weight": 1,
"Status": "online"
}
],
"ReadonlyLimit": 10,
"NodeCount": 2,
"RequestId": "mnksadas-cb0d-4943-9b17-c3306ed3d"
}
}
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 |
|---|---|
| InternalError.DBOperationError | Database operation failed. |
| InternalError.NetworkError | Network error |
| UnauthorizedOperation | Unauthorized operation. |
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