云数据库 Redis 查询复制组-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： redis.tencentcloudapi.com 。

本接口（DescribeReplicationGroup）用于查询复制组。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeReplicationGroup。
Version	是	String	公共参数，本接口取值：2018-04-12。
Region	是	String	公共参数，详见产品支持的地域列表。
Limit	是	Integer	每页输出实例列表的大小，参数默认值20。示例值：20
Offset	是	Integer	分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。示例值：0
GroupId	否	String	指定复制组 ID。例如：crs-rpl-m3zt****。请登录Redis 控制台的全球复制组列表获取复制组 ID。示例值：crs-rpl-deindi7de
SearchKey	否	String	模糊查询的关键字，可以设置为复制组ID或复制组名称进行模糊查询。请登录Redis 控制台的全球复制组列表获取复制组 ID及名称。示例值：crs-deindi7de

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	复制组数量。示例值：100
Groups	Array of Groups	复制组信息。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

查询单个复制组信息

输入示例

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

{
    "Limit": 20,
    "GroupId": "crs-rpl-lkgv****",
    "Offset": 0
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "65e950b9-78e8-49b1-9200-0e62a1925557",
        "Groups": [
            {
                "Status": 37,
                "Remark": "测试复制组",
                "InstanceCount": 1,
                "Instances": [
                    {
                        "Engine": "社区版Redis",
                        "Vip6": "",
                        "IPv6": "abc",
                        "UpdateTime": "2022-11-02 15:04:05",
                        "VpcID": 16770550,
                        "InstanceId": "crs-9c36****",
                        "RedisShardSize": 1024,
                        "RegionId": 1,
                        "RedisShardNum": 1,
                        "Status": 1,
                        "Vip": "10.0.4.42",
                        "DiskSize": 0,
                        "CreateTime": "2022-11-02 15:04:05",
                        "ProductType": 9,
                        "AppId": 0,
                        "Role": "rw",
                        "VPort": 6379,
                        "ZoneId": 1,
                        "InstanceName": "crs-test",
                        "RedisReplicasNum": 1,
                        "GrocerySysId": 1000259
                    }
                ],
                "RegionId": 1,
                "GroupName": "crs-ben-test",
                "AppId": 0,
                "GroupId": "crs-rpl-lkgv****"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.SystemError	内部系统错误，和业务无关。
InvalidParameterValue.ReplicationGroupNotExists	复制组不存在。

查询复制组

本页目录：