1. 接口描述
获取集群版实例分片信息接口请求域名： redis.tencentcloudapi.com 。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
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,
"Runid": "af8945d6271e030ea17829b07c08e6c417bbff3d",
"Connected": 1
},
{
"Keys": 0,
"Role": 1,
"ShardId": "1",
"ShardName": "crs-7ponppu3-003-02",
"Slots": "[]",
"Storage": 3035608,
"StorageSlope": 0,
"Runid": "0711f42e392386674313f264f371b1288d2f800f",
"Connected": 1
},
{
"Keys": 0,
"Role": 0,
"ShardId": "2",
"ShardName": "crs-7ponppu3-001-01",
"Slots": "[\"5461-10922\"]",
"Storage": 3160280,
"StorageSlope": 0.018086727708578,
"Runid": "abf321a8ee9d4117f55b84ad9d70c3ef53f485af",
"Connected": 1
},
{
"Keys": 0,
"Role": 1,
"ShardId": "2",
"ShardName": "crs-7ponppu3-001-02",
"Slots": "[]",
"Storage": 3036632,
"StorageSlope": 0,
"Runid": "9b8d9ec9ac452ab5a866cc8331a92c16e95e9dda",
"Connected": 1
},
{
"Keys": 0,
"Role": 0,
"ShardId": "3",
"ShardName": "crs-7ponppu3-002-01",
"Slots": "[\"10923-16383\"]",
"Storage": 3055440,
"StorageSlope": -0.015687562525272,
"Runid": "3f299a51ad59fe7781e98b9ce6c807332931119b",
"Connected": 1
},
{
"Keys": 0,
"Role": 1,
"ShardId": "3",
"ShardName": "crs-7ponppu3-002-02",
"Slots": "[]",
"Storage": 3035608,
"StorageSlope": 0,
"Runid": "0498c543d7a49d8f7fc27706edbaf5b38fcb31f6",
"Connected": 1
}
],
"TotalCount": 6,
"RequestId": "ca3000b6-bb8a-41fd-9074-11b5fda52d9f"
}
}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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.SystemError | 内部系统错误，和业务无关。 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |
| InvalidParameterValue.UnSupportedType | 实例类型不支持。 |