接口约束
5.3 分片与副本
5.3.3 查询分片信息
功能介绍
查询读写分离实例和集群实例的分片和副本信息，其中，读写分离实例仅Redis4.0和 Redis5.0的主备实例支持。
调试
您可以在API Explorer中调试该接口，并获取该接口关联的CLI示例： hcloud DCS ListGroupReplicationInfo。
URI
GET /v2/{project_id}/instance/{instance_id}/groups
表5-85 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID instance_id 是 String 实例ID。
请求参数
无
响应参数
状态码： 200
表5-86 响应 Body 参数
参数 参数类型 描述
group_list Array of InstanceGrou pListInfo objects
分片列表
参数 参数类型 描述
group_count Integer 实例分片总数。
表5-87 InstanceGroupListInfo
参数 参数类型 描述
group_id String 分片id group_name String 分片名称 replication_lis
t Array of InstanceRepli cationListInf o objects
每个分片包含的副本列表。
表5-88 InstanceReplicationListInfo
参数 参数类型 描述
replication_rol
e String 副本角色，取值有：
● master：表示主节点。
● slave：表示从节点。
replication_ip String 副本IP。
is_replication Boolean 是否是新加副本。
replication_id String 副本id。
node_id String 节点id。
status String 副本状态。
枚举值：
● Active
● Inactive az_code String 副本所在的可用区
参数 参数类型 描述 dimensions Array of
InstanceRepli cationDimen sionsInfo objects
副本对应的监控指标维度信息。可用于调用云监 控服务的查询监控数据指标相关接口
● 副本的监控维度为多维度，返回数组中包含两 个维度信息。从云监控查询监控数据时，要按 多维度传递指标维度参数，才能查询到监控指 标值
● 第一个维度为副本父维度信息，维度名称为 dcs_instance_id，维度值对应副本所在的实例 ID
● 第二个维度，维度名称为
dcs_cluster_redis_node,维度值为副本的监控 对象ID，与副本ID和节点ID不同。
表5-89 InstanceReplicationDimensionsInfo
参数 参数类型 描述
name String 监控维度名称
value String 维度取值
状态码： 500
表5-90 响应 Body 参数
参数 参数类型 描述
error_msg String 错误信息
最大长度：1024 error_code String 错误码
最大长度：9
error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024
状态码： 400
表5-91 响应 Body 参数
参数 参数类型 描述
error_msg String 错误信息
最大长度：1024
参数 参数类型 描述 error_code String 错误码
最大长度：9
error_ext_msg String 扩展错误信息(暂未使用，赋值为null) 最大长度：1024
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups
响应示例
状态码： 200
查询分片和副本信息成功
{ "group_list" : [ {
"group_id" : "35e1bed6-7de5-4898-9eb2-c362c783df15", "group_name" : "group-0",
"replication_list" : [ { "az_code" : "cn-north-4b", "is_replication" : false,
"node_id" : "8abfa7aa73291f15017329e1cda0002d", "replication_id" : "dfbd3f84-08bc-42f0-b538-01d03e6dc178", "replication_ip" : "192.168.76.25",
"replication_role" : "master", "status" : "Active",
"dimensions" : [ {
"name" : "dcs_instance_id",
"value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
}, {
"name" : "dcs_cluster_redis_node",
"value" : "8263dc69629c5b2d840e9816fa9c6200"
} ] }, {
"az_code" : "cn-north-4b", "is_replication" : false,
"node_id" : "8abfa7aa73291f15017329e1cdb0002e",
"replication_id" : "63d4c880-7050-464f-ab19-c8a297474d7d", "replication_ip" : "192.168.78.207",
"replication_role" : "slave", "status" : "Active", "dimensions" : [ {
"name" : "dcs_instance_id",
"value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
}, {
"name" : "dcs_cluster_redis_node",
"value" : "8263dc69629c5b2d840e9816fa9c6201"
} ] } ] }, {
"group_id" : "579a281f-6e63-4822-b0c7-e45c44b7c807", "group_name" : "group-1",
"replication_list" : [ { "az_code" : "cn-north-4b", "is_replication" : false,
"node_id" : "8abfa7aa73291f15017329e1cdbd002f",
"replication_id" : "6284c192-48d1-462b-8fd9-45dad067c1a2", "replication_ip" : "192.168.73.164",
"replication_role" : "master",
"status" : "Active", "dimensions" : [ {
"name" : "dcs_instance_id",
"value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
}, {
"name" : "dcs_cluster_redis_node",
"value" : "8263dc69629c5b2d840e9816fa9c6202"
} ] }, {
"az_code" : "cn-north-4b", "is_replication" : false,
"node_id" : "8abfa7aa73291f15017329e1cdc80030", "replication_id" : "b927de3b-42f3-45b5-b0e4-8547f0ef6727", "replication_ip" : "192.168.77.172",
"replication_role" : "slave", "status" : "Active", "dimensions" : [ {
"name" : "dcs_instance_id",
"value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
}, {
"name" : "dcs_cluster_redis_node",
"value" : "8263dc69629c5b2d840e9816fa9c6203"
} ] } ] }, {
"group_id" : "c17305c6-6651-42d9-86bf-5a6087076eb7", "group_name" : "group-2",
"replication_list" : [ { "az_code" : "cn-north-4b", "is_replication" : false,
"node_id" : "8abfa7aa73291f15017329e1cdd90031",
"replication_id" : "caa6636d-a5c1-43b8-990a-3dc134da4522", "replication_ip" : "192.168.76.143",
"replication_role" : "master", "status" : "Active",
"dimensions" : [ {
"name" : "dcs_instance_id",
"value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
}, {
"name" : "dcs_cluster_redis_node",
"value" : "8263dc69629c5b2d840e9816fa9c6204"
} ] }, {
"az_code" : "cn-north-4b", "is_replication" : false,
"node_id" : "8abfa7aa73291f15017329e1cde50032", "replication_id" : "4f46790d-a0b0-4a1b-aa02-1c554fccf62d", "replication_ip" : "192.168.72.66",
"replication_role" : "slave", "status" : "Active", "dimensions" : [ {
"name" : "dcs_instance_id",
"value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
}, {
"name" : "dcs_cluster_redis_node",
"value" : "8263dc69629c5b2d840e9816fa9c6205"
} ] } ] } ],
"group_count" : 3 }
状态码
状态码 描述
200 查询分片和副本信息成功
状态码 描述
500 内部服务错误
400 非法请求
错误码
请参见错误码。