Help Center> Distributed Cache Service> API Reference (Paris Region)> API V2> Shards and Replicas> Querying Instance Nodes
Updated on 2023-12-13 GMT+08:00
View PDF

Querying Instance Nodes

Function

This API is used to query nodes of a specified instance. Available for Redis 4.0, 5.0, and 6.0 instances. No node information will be returned when the instance is being created.

Constraints

Supported Redis versions: 4.0, 5.0, and 6.0

URI

GET /v2/{project_id}/instances/{instance_id}/logical-nodes

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

instance_id

String

Instance ID.

total

Integer

Number of nodes.

nodes

Array of NodesInfoResp objects

Node information.
Table 3 NodesInfoResp

Parameter

Type

Description

logical_node_id

String

Logical node ID.

name

String

Node name.

status

String

Node status. The value can be:

  • Creating

  • Active: running

  • Inactive: faulty

  • Deleting

  • AddSharding: Shards are being added.

Enumeration values:

  • Creating

  • Active

  • Inactive

  • Deleting

  • AddSharding

az_code

String

AZ code.

node_role

String

Node type. Options:

  • redis-server: Redis server node

  • redis-proxy: proxy node

Enumeration values:

  • redis-server

  • redis-proxy

node_type

String

Node role. Options:

  • master: master node

  • slave: standby node

  • proxy: node of a Proxy Cluster instance

Enumeration values:

  • master

  • slave

  • proxy

node_ip

String

Node IP address.

node_port

String

Node port.

node_id

String

Node ID.

priority_weight

Integer

Replica promotion priority.

is_access

Boolean

Whether the IP address of the node can be directly accessed.

group_id

String

Shard ID.

group_name

String

Shard name.

is_remove_ip

Boolean

Whether the IP address is removed from the read-only domain name.

replication_id

String

Replica ID.

dimensions

Array of InstanceReplicationDimensionsInfo objects

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 is the ID of the instance where the replica is located.

  • 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.
Table 4 InstanceReplicationDimensionsInfo

Parameter

Type

Description

name

String

Monitoring dimension name.

value

String

Dimension value.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Maximum: 1024

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Maximum: 1024

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/logical-nodes?status={status}

Example Responses

Status code: 200

Node information queried successfully.

{
  "instance_id" : "11368fbb-de1e-4613-9080-1c374b71a1af",
  "total" : 1,
  "nodes" : [ {
    "logical_node_id" : "79653bcbd0e5c104fefedd188aa372d6",
    "name" : "(master)192.168.68.157",
    "status" : "Active",
    "az_code" : "region01",
    "node_role" : "redis-server",
    "node_type" : "master",
    "node_ip" : "192.168.68.157",
    "node_id" : "ff80808189bf92a50189d330303b77aa",
    "is_access" : true,
    "group_id" : "6e0f6e95-57cd-4baf-86d6-bea8815b25a8",
    "group_name" : "group-0",
    "priority_weight" : 100,
    "is_remove_ip" : false,
    "dimensions" : [ {
      "name" : "dcs_instance_id",
      "value" : "11368fbb-de1e-4613-9080-1c374b71a1af"
    }, {
      "name" : "dcs_cluster_redis_node",
      "value" : "79653bcbd0e5c104fefedd188aa372d6"
    } ],
    "replication_id" : null
  } ]
}

Status code: 500

Internal service error.

{
  "error_code" : "DCS.5000",
  "error_msg" : "Internal service error."
}

Status code: 400

Invalid request.

{
  "error_code" : "DCS.4800",
  "error_msg" : "Invalid offset in the request."
}

Status Codes

Status Code

Description

200

Node information queried successfully.

500

Internal service error.

400

Invalid request.

Error Codes

See Error Codes.

Parent topic: Shards and Replicas