文档中心 云数据库 Redis API文档 实例相关接口 获取集群版实例分片信息

获取集群版实例分片信息

最近更新时间：2019-07-24 15:31:48

查看pdf

在这篇文章中：

1. 接口描述

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

获取集群版实例分片信息

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

注意：本接口支持金融区地域。由于金融区和非金融区是隔离不互通的，因此当公共参数 Region 为金融区地域（例如 ap-shanghai-fsi）时，需要同时指定带金融区地域的域名，最好和 Region 的地域保持一致，例如：redis.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeInstanceShards
Version 是 String 公共参数，本接口取值：2018-04-12
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 实例id
FilterSlave 否 Boolean 是否过滤掉从节信息

3. 输出参数

参数名称 类型 描述
InstanceShards Array of InstanceClusterShard 实例分片列表信息
TotalCount Integer 实例分片节点总数
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://redis.tencentcloudapi.com/?Action=DescribeInstanceShards
&InstanceId=crs-7ponppu3
&<公共请求参数>

输出示例

{
  "Response": {
    "InstanceShards": [
      {
        "Keys": 0,
        "Role": 0,
        "ShardId": "1",
        "ShardName": "crs-7ponppu3-003-01",
        "Slots": "[\"0-5460\"]",
        "Storage": 3096688,
        "StorageSlope": -0.002399486489594
      },
      {
        "Keys": 0,
        "Role": 1,
        "ShardId": "1",
        "ShardName": "crs-7ponppu3-003-02",
        "Slots": "[]",
        "Storage": 3035608,
        "StorageSlope": 0
      },
      {
        "Keys": 0,
        "Role": 0,
        "ShardId": "2",
        "ShardName": "crs-7ponppu3-001-01",
        "Slots": "[\"5461-10922\"]",
        "Storage": 3160280,
        "StorageSlope": 0.018086727708578
      },
      {
        "Keys": 0,
        "Role": 1,
        "ShardId": "2",
        "ShardName": "crs-7ponppu3-001-02",
        "Slots": "[]",
        "Storage": 3036632,
        "StorageSlope": 0
      },
      {
        "Keys": 0,
        "Role": 0,
        "ShardId": "3",
        "ShardName": "crs-7ponppu3-002-01",
        "Slots": "[\"10923-16383\"]",
        "Storage": 3055440,
        "StorageSlope": -0.015687562525272
      },
      {
        "Keys": 0,
        "Role": 1,
        "ShardId": "3",
        "ShardName": "crs-7ponppu3-002-02",
        "Slots": "[]",
        "Storage": 3035608,
        "StorageSlope": 0
      }
    ],
    "RequestId": "ca3000b6-bb8a-41fd-9074-11b5fda52d9f"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力，能显著降低使用云 API 的难度，推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误，和业务无关。
InvalidParameter.PermissionDenied 接口没有cam权限。
InvalidParameterValue.UnSupportedType 实例类型不支持。

云数据库 Redis 相关文档