文档首页/ 分布式缓存服务 DCS/ API参考/ 历史API/ 实例管理/ 查询分片信息
更新时间：2023-11-28 GMT+08:00
查看PDF
分享

查询分片信息

功能介绍

查询读写分离实例和集群实例的分片和副本信息，其中，读写分离实例仅Redis4.0和Redis5.0的主备实例支持。

该接口当前仅在华北-北京四区域开放。

URI

GET /v1.0/{project_id}/instance/{instance_id}/groups

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

instance_id

是

String

实例ID。

请求消息

请求参数

无

请求示例

请求URL：

GET https://{dcs_endpoint}/v1.0/{project_id}/instance/{instance_id}/groups

响应消息

响应参数

表1 响应参数

参数

参数类型

描述

group_count

String

实例分片总数。

group_list

Array of objects

分片列表。具体参数请参见表2。
表2 group_list参数说明

参数

参数类型

描述

group_id

String

分片id

group_name

String

分片名称

replication_list

Array of objects

每个分片包含的副本列表。具体参数请参见表3。
表3 replication_list参数说明

参数

参数类型

描述

replication_ip

String

副本IP。

replication_role

String

副本角色，取值有：

  • master：表示主节点。
  • slave：表示从节点。

node_id

String

节点ID。

replication_id

String

副本ID。

is_replication

Boolean

是否是新加副本。

status

String

副本状态。

响应示例

状态码为 200 时:

{
    "group_list": [
        {
            "group_id": "a11d3ba3-7898-4371-bfbe-783ab9280cc7",
            "group_name": "group-2",
            "replication_list": [
                {
                    "replication_ip": "192.168.0.156",
                    "replication_role": "master",
                    "node_id": "8aa6999f6de47c69016df0e7de1c23de",
                    "replication_id": "1a5f2b63-eedc-4bb1-a25f-262b5d604a1f",
                    "is_replication": false,
                    "status": "Active"
                },
                {
                    "replication_ip": "192.168.0.45",
                    "replication_role": "slave",
                    "node_id": "8aa6999f6de47c69016df0e7de2e23df",
                    "replication_id": "2b892b07-dfe8-4b86-98cc-736b4e8e420f",
                    "is_replication": false,
                    "status": "Active"
                }
            ]
        },
        {
            "group_id": "2ba84ddc-558c-4465-bfe9-dbfaac024565",
            "group_name": "group-1",
            "replication_list": [
                {
                    "replication_ip": "192.168.0.95",
                    "replication_role": "master",
                    "node_id": "8aa6999f6de47c69016df0e7ddf623dc",
                    "replication_id": "b46cbcca-05a7-47b0-bd01-df768a1faf73",
                    "is_replication": false,
                    "status": "Active"
                },
                {
                    "replication_ip": "192.168.0.204",
                    "replication_role": "slave",
                    "node_id": "8aa6999f6de47c69016df0e7de0923dd",
                    "replication_id": "56ddd52e-0c95-40f2-a596-b578456c1431",
                    "is_replication": false,
                    "status": "Active"
                }
            ]
        },
        {
            "group_id": "995e1f3b-f9c0-4acf-ad9d-89123d1fd12a",
            "group_name": "group-0",
            "replication_list": [
                {
                    "replication_ip": "192.168.0.233",
                    "replication_role": "master",
                    "node_id": "8aa6999f6de47c69016df0e7ddd223da",
                    "replication_id": "71749f79-e9ea-4173-8bfa-b97357153af8",
                    "is_replication": false,
                    "status": "Active"
                },
                {
                    "replication_ip": "192.168.0.27",
                    "replication_role": "slave",
                    "node_id": "8aa6999f6de47c69016df0e7dde423db",
                    "replication_id": "707b7318-9766-47a8-91ad-7d0feab64229",
                    "is_replication": false,
                    "status": "Active"
                }
            ]
        }
    ],
    "group_count": 3
}

返回值

返回值

描述

200

查询分片信息成功

错误码

无

父主题： 实例管理

相关文档