SVsvix
ClusterAdmin

Cluster Status

Changed on

Get information about the current cluster

get/api/v1.cluster-admin.status

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Response

cluster_idstring nullable

The unique ID of this cluster.

This value is populated on cluster initialization and will never change.

cluster_namestring nullable

The name of this cluster (as defined in the config)

This value is not replicated and should only be used for debugging.

this_node_idstring required

The unique ID of the node servicing this request

this_node_state'leader' | 'follower' | 'learner' | 'candidate' | 'shutdown' | 'unknown' required
this_node_last_committed_timestampinteger required

The timestamp of the last transaction committed on this node

this_node_last_snapshot_idstring nullable

The last snapshot taken on this node

this_node_last_purged_log_indexinteger nullable

The last-purged log on this node

Example response

{
  "this_node_id": "a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8",
  "nodes": [
    {
      "node_id": "a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8"
    }
  ]
}

Changes

  • 4911827555b2Revision changes
    • info

      added the optional property to the response with the status

  • a542ced3f593Revision changes
    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status