DescribeRoGroups

最后更新时间:2021-10-12 17:21:00

1. API Description

Domain name for API request: cdb.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.

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.

2. Input Parameters

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 parameter. The value used for this API: DescribeRoGroups.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
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.

3. Output Parameters

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the information of all RO groups of a TencentDB instance

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeRoGroups
&InstanceId=cdb-eggz8oj5
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "RoGroups": [
      {
        "RoGroupName": "ro_group_172023",
        "RoMaxDelayTime": 1,
        "RoOfflineDelay": 0,
        "RoInstances": [
          {
            "Zone": "ap-guangzhou-3",
            "MasterInstanceId": "cdb-eggz8oj5",
            "Memory": 2000,
            "Status": 1,
            "VpcId": 0,
            "InstanceId": "cdbro-h9k7cx05",
            "Volume": 100,
            "SubnetId": 0,
            "HourFeeStatus": 1,
            "RoStatus": "online",
            "OfflineTime": "0000-00-00 00:00:00",
            "Region": "ap-guangzhou",
            "DeadlineTime": "2018-01-04 16:48:30",
            "DeviceType": "CUSTOM",
            "EngineVersion": "5.6",
            "TaskStatus": 1,
            "InstanceName": "cdb_ro_172023",
            "Weight": 1,
            "PayType": 0,
            "InstanceType": 3,
            "Vip": "10.66.199.133",
            "Qps": 2400,
            "Vport": 3306
          }
        ],
        "RoGroupId": "cdbrg-eb2w7dto",
        "Vip": "10.66.199.133",
        "MinRoInGroup": 1,
        "Vport": 3306,
        "WeightMode": "system"
      }
    ]
  }
}

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
CdbError Backend or process error.
InternalError.DBError Database exception
InternalError.FtpError File transfer exception
InternalError.HttpError Exceptional HTTP request
InternalError.UnknownError Unknown error
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.
OperationDenied.ActionNotSupport Unsupported operation.