缓存数据库 Redis 版
缓存数据库 Redis 版
缓存数据库 Redis 版
文档指南
请输入
产品动态
产品公告
用户指南
实例管理
网络连接管理
参数管理
性能分析
最佳实践
开发参考（控制面）
API 参考
实例管理
变更实例配置
备份恢复
参数管理
连接管理
账号管理
白名单管理
事件管理
性能分析
任务中心
Terraform 参考
开发参考（数据面）
命令支持
常见问题
报错和异常
相关视频
- 文档首页
缓存数据库 Redis 版开发参考（控制面）API 参考实例管理DescribeDBInstanceShards
复制全文
下载 pdfDescribeDBInstanceShards
文档反馈
问问助手调用 DescribeDBInstanceShards 接口查询目标 Redis 实例下各 Shard 分片的 Server 节点详情。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InstanceId | String | 是 | redis-cn0212gzmh2xs**** | 实例 ID。 说明 |
PageNumber | Integer | 是 | 1 | 实例信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。 |
PageSize | Integer | 是 | 10 | 每页记录数。取值为 1~100 间的整数。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Total | Integer | 2 | 当前实例中的分片总数量。 |
InstanceShards | 请参见返回示例。 | 实例中所有 Shard 分片的详情列表。 |
InstanceShardInfo
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
ShardId | String | server-redis-cnlf55bkfgx2s****-0 | 分片 ID。 |
NodeNumber | Integer | 2 | 分片中的节点数量。 |
ServerNodes | 请参见返回示例。 | 分片中所有 Server 节点的详情列表。 |
ServerNodeInfo
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
NodeId | String | server-redis-cnlf55bkfgx2s****-0-0 | 节点 ID。 |
Status | String | running | 节点状态。取值范围如下：
|
ZoneId | String | cn-beijing-a | 节点所在的可用区。 |
CurrentRole | String | PrimaryNode | 节点当前的角色。取值范围如下：
|
示例
请求示例
POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceShards&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
"InstanceId": "redis-cn0212gzmh2xs****",
"PageNumber": 1,
"PageSize": 10
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202309211602263758842C63CA00Exxxx",
"Action": "DescribeDBInstanceShards",
"Version": "2020-12-07",
"Service": "Redis",
"Region": "cn-beijing"
},
"Result": {
"InstanceShards": [
{
"NodeNumber": 2,
"ServerNodes": [
{
"CurrentRole": "PrimaryNode",
"NodeId": "server-redis-cn0212gzmh2xs****-0-0",
"Status": "running",
"ZoneId": "cn-beijing-a"
},
{
"CurrentRole": "SecondaryNode",
"NodeId": "server-redis-cn0212gzmh2xs****-0-1",
"Status": "running",
"ZoneId": "cn-beijing-a"
}
],
"ShardId": "server-redis-cn0212gzmh2xs****-0"
},
{
"NodeNumber": 2,
"ServerNodes": [
{
"CurrentRole": "PrimaryNode",
"NodeId": "server-redis-cn0212gzmh2xs****-1-0",
"Status": "running",
"ZoneId": "cn-beijing-a"
},
{
"CurrentRole": "SecondaryNode",
"NodeId": "server-redis-cn0212gzmh2xs****-1-1",
"Status": "running",
"ZoneId": "cn-beijing-a"
}
],
"ShardId": "server-redis-cn0212gzmh2xs****-1"
}
],
"Total": 2
}
}
错误码
最近更新时间：2026.09.21 14:23:31
这个页面对您有帮助吗？
有用
有用
无用
无用