获取集群版实例分片信息

最近更新时间:2024-08-21 02:04:26

我的收藏

1. 接口描述

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

本接口(DescribeInstanceShards)用于获取集群架构实例的分片信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceShards。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
示例值:crs-7ponppu3
FilterSlave Boolean 是否过滤掉从节信息。
- true;过滤从节点。
- false:不过滤。
示例值:false

3. 输出参数

参数名称 类型 描述
InstanceShards Array of InstanceClusterShard 实例分片列表信息,包括:节点信息、节点ID、Key数量、使用容量、容量倾斜率等信息。
TotalCount Integer 实例分片节点数量。
示例值:6
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

获取集群版实例分片信息

输入示例

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

{
    "InstanceId": "crs-7pon****",
    "FilterSlave": true
}

输出示例

{
    "Response": {
        "InstanceShards": [
            {
                "ShardName": "abc",
                "ShardId": "abc",
                "Role": 0,
                "Keys": 0,
                "Slots": "abc",
                "Storage": 0,
                "StorageSlope": 0,
                "Runid": "abc",
                "RunId": "abc",
                "Connected": 0
            }
        ],
        "TotalCount": 0,
        "RequestId": "abc"
    }
}

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 内部系统错误,和业务无关。
InvalidParameter.PermissionDenied 接口没有cam权限。
InvalidParameterValue.UnSupportedType 实例类型不支持。