Get cluster health overview

GET /v1/cluster/health_overview

Get cluster health overview.

Responses

  • 200 application/json

    Cluster health overview response

    Hide response attributes Show response attributes object
    • all_nodes array[integer(int32)]

      Node IDs of all brokers registered in the cluster

    • controller_id integer(int32)

      Broker that is currently a leader or -1 if leader is not elected

    • is_healthy boolean

      Basic cluster health indicator

    • leaderless_partitions array[string]

      List of partitions for which no leader is elected

    • under_replicated_partitions array[string]

      List of partitions where one or more replicas hasn't replicated all data

    • bytes_in_cloud_storage integer

      Total amount of bytes in object storage, or -1 if unable to obtain data

    • nodes_down array[integer(int32)]

      Node IDs of all brokers that are recognized as down
GET /v1/cluster/health_overview 
curl \
 --request GET 'http://localhost:9644/v1/cluster/health_overview'
Response examples (200) 
{
  "all_nodes": [
    42
  ],
  "controller_id": 42,
  "is_healthy": true,
  "leaderless_partitions": [
    "string"
  ],
  "under_replicated_partitions": [
    "string"
  ],
  "bytes_in_cloud_storage": 42,
  "nodes_down": [
    42
  ]
}