Obtaining the Replica Status

Function

This API is used to obtain the status of a shard replica.

URI

GET /v2/{project_id}/instance/{instance_id}/groups/{group_id}/group-nodes-state

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.
group_id	Yes	String	Shard ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
[items]	Array of InstanceReplicationListInfo objects	Replica list.

**Table 3** 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	Definition Replica status. Range Active: Running Inactive: Abnormal
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 4** 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 5** 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 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.

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups/{group_id}/group-nodes-state

Example Responses

Status code: 200

Details of shards and replicas queried successfully.

[ {
  "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"
  } ]
} ]