ClusterAdmin

Cluster Status

Get information about the current cluster

get/api/v1.cluster-admin.status

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

Changed in 6 of the 53 revisions of this API.21223

    • added the optional property this_node_last_purged_log_index to the response with the 200 status

      response-optional-property-added

  • a542ced3f5931212See the full diff
    • added the new invalid-input enum value to the type response property for the response status 400

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

    • removed the invalid_input enum value from the type response property for the response status 400

      response-property-enum-value-removed

    • removed the invalid_input enum value from the type response property for the response status 401

      response-property-enum-value-removed

    • removed the invalid_input enum value from the type response property for the response status 403

      response-property-enum-value-removed

    • removed the invalid_input enum value from the type response property for the response status 422

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 400

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 401

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 403

      response-property-enum-value-removed

    • removed the operation_error enum value from the type response property for the response status 422

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 400

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 401

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 403

      response-property-enum-value-removed

    • removed the server_error enum value from the type response property for the response status 422

      response-property-enum-value-removed

    • added the required property type to the response with the 400 status

      response-required-property-added

    • added the required property type to the response with the 401 status

      response-required-property-added

    • added the required property type to the response with the 403 status

      response-required-property-added

    • added the required property type to the response with the 422 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c3022218176815See the full diff
    • the detail response's property type/format changed from array/ to string/ for status 422

      response-property-type-changed

    • added the optional property location to the response with the 400 status

      response-optional-property-added

    • added the optional property location to the response with the 401 status

      response-optional-property-added

    • added the optional property location to the response with the 403 status

      response-optional-property-added

    • added the optional property location to the response with the 422 status

      response-optional-property-added

    • added the required property code to the response with the 422 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog