Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query the information of all RO groups of a TencentDB instance.
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: DescribeRoGroups. |
| 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. 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-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| InstanceId | Yes | String | Instance ID in the format of cdb-c1nl9rpv or cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. |
| Parameter Name | Type | Description |
|---|---|---|
| RoGroups | Array of RoGroup | RO group information array. An instance can be associated with multiple RO groups. |
| 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: DescribeRoGroups
<common request parameters>
{
"InstanceId": "cdb-93hvfefg"
}{
"Response": {
"RequestId": "5e18a101-e6f5-440c-a9d3-3b30aef256e1",
"RoGroups": [
{
"DelayReplicationTime": 0,
"MinRoInGroup": 1,
"RoGroupId": "cdbrg-lsj**ijm",
"RoGroupMode": "",
"RoGroupName": "tommy1",
"RoGroupRegion": "ap-beijing",
"RoGroupZone": "ap-beijing-6",
"RoInstances": [
{
"DeadlineTime": "2024-11-12 16:11:06",
"DeviceType": "CUSTOM",
"EngineVersion": "8.0",
"HourFeeStatus": 1,
"InstanceId": "cdbro-lsjh**jm",
"InstanceName": "cdb_ro_21**63",
"InstanceType": 3,
"MasterInstanceId": "cdb-93**fefg",
"Memory": 4000,
"OfflineTime": "2024-01-25 15:05:59",
"PayType": 0,
"Qps": 4400,
"Region": "ap-beijing",
"RoStatus": "online",
"Status": 1,
"SubnetId": 2738750,
"TaskStatus": 0,
"Vip": "172.*.32.13",
"Volume": 60,
"VpcId": 7078258,
"Vport": 3306,
"Weight": 2,
"Zone": "ap-beijing-6"
}
],
"RoMaxDelayTime": 10,
"RoOfflineDelay": 1,
"UniqSubnetId": "subnet-jp6**13n",
"UniqVpcId": "vpc-4ko**3u6",
"Vip": "172.*.64.7",
"Vport": 3306,
"Weight": 0,
"WeightMode": "system"
}
]
}
}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 |
|---|---|
| CdbError | Backend or process error. |
| InternalError.DBError | Database exception |
| InternalError.FtpError | File transfer exception |
| InternalError.HttpError | Exceptional HTTP request |
| InternalError.UndefinedError | Unknown error |
| InternalError.UnknownError | Unknown error |
| InvalidParameter | Parameter error. |
| InvalidParameter.ControllerNotFoundError | This API was not found. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| OperationDenied.ActionNotSupport | Unsupported 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