View Cluster

  "username" : "root",
  "password" : "root",
  "q" : "view-cluster"

Provides a layout of the cluster that includes the node-id, ip address, online status and current load factor of all nodes. The command returns the list of all nodes that are registered with the cluster irrespective of whether they are currently online or offline.

Response Structure

  "ack" : "1",
  "time" : 1000,
  "p" : {
    "nodes" : [
        "node-id" : "1",
        "ip" : "",
        "status" : "online",
        "load" : 0.8
        "node-id" : "2",
        "ip" : "",
        "status" : "offline"

The details of the nodes are collected into a JSONArray mapped to the key nodes in the response payload. Each element of the JSONArray is a JSONObject that represents in a single node. The parameters of the JSONObject are explained in the below table.

node-idUnique identifier of the node
ipThe IP address of the node
status-One of online, offline, syncing, shutting
-An online status indicates that the node is active, connected to the cluster and fully working.
-An offline status indicates that the node is powered down or disconnected form the cluster, but definitely not reachable for any operations.
-A syncing status indicates that the nodes is performing a first time connect or reconnection to the cluster and data sync is in progress. On successful sync
operation the status will change to online.
-A shutting status indicates that a graceful power down command has been fired up on the node, and the node is currently executing the shutdown.
loadReported only for online nodes. Indicates the current load factor of the node
as value in the range of 0 to 1 with 1 being a heavily loaded node.