查询复制组信息

最近更新时间:2024-06-17 02:06:36

我的收藏

1. 接口描述

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

查询复制组信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeReplicationGroupInstance。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
示例值:crs-deindi7de

3. 输出参数

参数名称 类型 描述
AppId Integer AppID。
示例值:251006366
RegionId Integer 地域数字编号。
示例值:1
GroupId String 复制组字符串ID。
示例值:crs-rpl-qhj4wgcn
GroupName String 复制组名称。
示例值:复制组测试
InstanceRole String 实例复制组角色。
- r: 备实例
- rw: 主实例
示例值:r
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询复制组信息

查询实例对应的复制组信息

输入示例

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

{
    "InstanceId": "crs-a7oxxxxx"
}

输出示例

{
    "Response": {
        "AppId": 251237400,
        "GroupId": "crs-rpl-oxsincth",
        "GroupName": "test",
        "InstanceRole": "rw",
        "RegionId": 1,
        "RequestId": "02ef9326-3db7-47ab-8f65-c6d1a772f71c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
InternalError.CamAuthOssResponseReturnCodeError cam鉴权错误。
InternalError.DbOperationFailed 统一的 DB 操作错误,可以是 update insert select..。
InvalidParameter.InvalidParameter 业务参数错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。