Endpoint

/v1/node/state

GET

Retrieves node state of the node that the call was made to.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_node_state",
  "type": "object",
  "properties": {
    "node_id": {
      "description": "node-id of the node responding to the get",
      "type": "number"
    },
    "state": {
      "type": "string",
      "enum": [
        "UNCONFIGURED",
        "STOPPED",
        "PAUSED",
        "ACTIVE",
        "REMOVED"
      ],
      "description": "The state of the node:\n * `ACTIVE` - Configured node part of active quorum,\n * `PAUSED` - Configured node part of paused quorum,\n * `REMOVED` - Configured node that has been removed from its cluster,\n * `STOPPED` - Configured node not part of quorum,\n * `UNCONFIGURED` - Unconfigured node"
    },
    "cluster_id": {
      "description": "Unique identifier of cluster the node belongs to or the empty string ('') if the node is unconfigured",
      "type": "string"
    }
  }
}