Help Center/ Distributed Cache Service/ API Reference/ API V2/ Shards and Replicas/ Querying Instance Nodes in Batches
Updated on 2025-05-13 GMT+08:00
View PDF

Querying Instance Nodes in Batches

Function

This API is used to query the node information, number of valid instances, and number of nodes of all instances in a specified project.

No node information will be returned when the instance is being created.

Available for Redis 4.0 and later instances.

Constraints

Available for Redis 4.0 and later instances.

Calling Method

For details, see Calling APIs.

URI

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

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Parameter description:

Offset where the query starts.

Constraints:

N/A.

Value range:

≥ 0

Default value:

0

limit

No

Integer

Parameter description:

Number of records displayed on each page.

Constraints:

N/A.

Value range:

1–100

Default value:

10

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

Parameter description:

Total number of instances in the query result.

Value range:

N/A.

instances

Array of InstanceNodesInfoResp objects

Parameter description:

Instance list.

Value range:

N/A.
Table 4 InstanceNodesInfoResp

Parameter

Type

Description

instance_id

String

Parameter description:

Instance ID.

Value range:

N/A.

node_count

Integer

Parameter description:

Total number of nodes of the current instance.

Value range:

N/A.

nodes

Array of NodesInfoResp objects

Parameter description:

Node details.

Value range:

N/A.
Table 5 NodesInfoResp

Parameter

Type

Description

logical_node_id

String

Parameter description:

Logical node ID.

Value range:

N/A.

name

String

Parameter description:

Node name.

Value range:

N/A.

status

String

Parameter description:

Node status.

Value range:

  • Creating

  • Active: Running

  • Inactive: Faulty

  • Deleting

  • AddSharding: A shard is being added.

az_code

String

Parameter description:

AZ code.

Value range:

N/A.

node_role

String

Parameter description:

Node role.

Value range:

  • redis-server: Redis server node

  • redis-proxy: proxy node

node_type

String

Parameter description:

Node master/standby role.

Value range:

  • master: master node

  • slave: standby node

  • proxy: node of a Proxy Cluster instance

node_ip

String

Parameter description:

Node IP.

Value range:

N/A.

node_port

String

Parameter description:

Node port.

Value range:

N/A.

node_id

String

Parameter description:

Node ID.

Value range:

N/A.

priority_weight

Integer

Parameter description:

Replica promotion priority.

Value range:

Priority ranges from 0 to 100 in descending order. 0 indicates that the replica will never be automatically promoted, 1 indicates the highest priority, and 100 indicates the lowest priority.

is_access

Boolean

Parameter description:

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

Value range:

  • true

  • false

group_id

String

Parameter description:

Instance shard ID.

Value range:

N/A.

group_name

String

Parameter description:

Instance shard name.

Value range:

N/A.

is_remove_ip

Boolean

Parameter description:

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

Value range:

  • true

  • false

replication_id

String

Parameter description:

Instance replica ID.

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 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.

Value range:

N/A.
Table 6 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 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.

Status code: 400

Table 8 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}/instances-logical-nodes?offset={offset}&limit={limit}

Example Responses

Status code: 200

Node information queried successfully.

{
  "count" : 1,
  "instances" : [ {
    "instance_id" : "b4468cb1-4f75-4866-a49d-86959acc0c9c",
    "node_count" : 2,
    "nodes" : [ {
      "logical_node_id" : "8f997eb512a92834bf5914be52ca8919",
      "name" : "(replica)192.168.0.178",
      "status" : "Active",
      "az_code" : "region01",
      "node_role" : "redis-server",
      "node_type" : "slave",
      "node_ip" : "192.168.0.178",
      "node_port" : "6379",
      "node_id" : "8a2c26c17f4d6516017f4d7b77940030",
      "is_access" : true,
      "group_id" : "ace962d1-7841-4e50-9313-c239fd75dee3",
      "group_name" : "group-0",
      "priority_weight" : 100,
      "is_remove_ip" : false,
      "replication_id" : "e40aa09e-03c2-4319-86eb-5ef4ca637544",
      "dimensions" : [ {
        "name" : "dcs_instance_id",
        "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
      }, {
        "name" : "dcs_cluster_redis_node",
        "value" : "8263dc69629c5b2d840e9816fa9c6200"
      } ]
    } ]
  } ]
}

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