Help Center/ Distributed Cache Service/ API Reference/ API V2/ Shards and Replicas/ Querying Instance Nodes in Batches
Updated on 2022-09-19 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 instances are being created. Only DCS Redis 4.0 and 5.0 instances can be queried.

Constraints

Only DCS Redis 4.0 and 5.0 instances can be queried.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of items displayed on each page. The maximum value is 1000*. If this parameter is not specified, 10 items are displayed on each page by default.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

Total number of instances in the query result.

instances

Array of InstanceNodesInfoResp objects

Instance list.
Table 4 InstanceNodesInfoResp

Parameter

Type

Description

instance_id

String

Instance ID.

node_count

Integer

Total number of nodes of the current instance.

nodes

Array of NodesInfoResp objects

Node details.
Table 5 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. The value can be:

  • redis-server: Redis server node.
  • redis-proxy: proxy node.

Enumeration values:

  • redis-server
  • redis-proxy

node_type

String

Node role. The value can be:

  • master
  • slave
  • 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

Node weight.

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 monitored object ID of the replica, which is different from the replica ID or node ID.
Table 6 InstanceReplicationDimensionsInfo

Parameter

Type

Description

name

String

Monitoring dimension name.

value

String

Dimension value.

Status code: 500

Table 7 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 8 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-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" : "xxxxxx",
      "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