Querying Details of Shards

Function

This API is used to query information about shards and replicas of Redis 4.0 and later instances (single-node ones not included).

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instance/{instance_id}/groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A. Value range: N/A. Default value: N/A.
instance_id	Yes	String	Parameter description: Instance ID, which can be viewed on the instance details page on the DCS console. Constraints: N/A. Value range: N/A. Default value: N/A.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
group_list	Array of InstanceGroupListInfo objects	Parameter description: Instance shard list. Value range: N/A.
group_count	Integer	Parameter description: Total number of shards in the instance. Value range: N/A.

**Table 3** InstanceGroupListInfo
Parameter	Type	Description
group_id	String	Parameter description: Instance shard ID. Value range: N/A.
group_name	String	Parameter description: Instance shard name. Value range: N/A.
replication_list	Array of InstanceReplicationListInfo objects	Parameter description: List of replicas in the shard. Value range: N/A.

**Table 4** InstanceReplicationListInfo
Parameter	Type	Description
replication_role	String	Parameter description: Replica role. Value range: master: master node slave: standby node.
replication_ip	String	Parameter description: Replica IP address. Value range: N/A.
is_replication	Boolean	Parameter description: Whether the replica is newly added. Value range: true false
replication_id	String	Parameter description: Replica ID. Value range: N/A.
node_id	String	Parameter description: Node ID. Value range: N/A.
status	String	Parameter description: Replica status. Value range: N/A.
az_code	String	Parameter description: AZ where the replica is in. Value range: N/A.
dimensions	Array of InstanceReplicationDimensionsInfo objects	Parameter description: Monitoring metric dimension of the replica used to call the Cloud Eye API for querying monitoring metrics. Replica monitoring is multi-dimensional. The returned array contains information about two dimensions. When querying monitoring data from Cloud Eye, transfer parameters of multiple dimensions to obtain the metric data. The first dimension is the primary dimension of the replica. The dimension name is dcs_instance_id, and the dimension value corresponds to the ID of the instance to which the replica belongs. The name of the second dimension is dcs_cluster_redis_node, and the dimension value is the ID of the monitored object of the replica, which is different from the replica ID or node ID. Value range: N/A.

**Table 5** InstanceReplicationDimensionsInfo
Parameter	Type	Description
name	String	Parameter description: Monitoring dimension name. Value range: dcs_instance_id: instance dimension dcs_cluster_redis_node: data node dimension
value	String	Parameter description: Dimension value. Value range: N/A.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups

Example Responses

Status code: 200

Details of shards and replicas queried successfully.

{
  "group_list" : [ {
    "group_id" : "35e1bed6-7de5-4898-9eb2-c362c783df15",
    "group_name" : "group-0",
    "replication_list" : [ {
      "az_code" : "region01",
      "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" : "region01",
      "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" : "region01",
      "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" : "region01",
      "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" : "region01",
      "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" : "region01",
      "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
}