有奖捉虫:云通信与企业服务文档专题,速来> HOT
文档中心 > 云数据库 MySQL > API 文档 > 实例相关接口 > 查询云数据库实例的所有RO组的信息

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(DescribeRoGroups)用于查询云数据库实例的所有的RO组的信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRoGroups。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID,格式如:cdb-c1nl9rpv或者cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同。
示例值:cdb-eggz8oj5

3. 输出参数

参数名称 类型 描述
RoGroups Array of RoGroup RO组信息数组,一个实例可关联多个RO组。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云数据库实例的所有RO组的信息

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoGroups
<公共请求参数>

{
    "InstanceId": "cdb-eggz8oj5"
}

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "RoGroups": [
            {
                "RoGroupName": "ro_group_172023",
                "RoMaxDelayTime": 1,
                "RoOfflineDelay": 0,
                "RoGroupMode": "alone",
                "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
CdbError 后端错误或者流程错误。
InternalError.DBError 数据库异常。
InternalError.FtpError 文件传输异常。
InternalError.HttpError Http请求异常。
InternalError.UndefinedError 未知错误。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.ControllerNotFoundError 未找到该接口。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied.ActionNotSupport 不支持的操作。