Get cluster view

View as Markdown
GET /v1/cluster_view

Get a summary view of a cluster and its brokers.

Responses

  • 200 application/json

    Cluster view response

    Hide response attributes Show response attributes object
    • brokers array[object]

      Broker information

      Hide brokers attributes Show brokers attributes object
      • disk_space array[object]

        Array of disk space information per directory path. If disk space information is not available the array may be empty

        Hide disk_space attributes Show disk_space attributes object
        • free integer(int64)

          free space bytes

        • path string

          data directory path

        • total integer(int64)

          total space bytes

      • is_alive boolean

        Whether the cluster considers the broker alive

      • maintenance_status object

        Drain status

        Hide maintenance_status attributes Show maintenance_status attributes object
        • draining boolean

          in maintenance state

        • eligible integer(int64)

          eligible partition count

        • errors boolean

          drain errors

        • failed integer(int64)

          failed transfer partition count

        • finished boolean

          drain finished

        • partitions integer(int64)

          partition count

        • transferring integer(int64)

          transferring partition count

      • membership_status string

        Broker membership status

      • node_id integer(int64)

        node id

      • num_cores integer(int64)

        cores

      • rack string

        rack id

      • internal_rpc_address string

        Internal RPC address (usually, but not necessarily, a hostname)

      • internal_rpc_port integer

        Internal RPC port

      • version string

        Redpanda version

    • version integer(int64)

      cluster view version

GET /v1/cluster_view
curl \ --request GET 'http://localhost:9644/v1/cluster_view'
Response examples (200)
{ "brokers": [ { "disk_space": [ { "free": 42, "path": "string", "total": 42 } ], "is_alive": true, "maintenance_status": { "draining": true, "eligible": 42, "errors": true, "failed": 42, "finished": true, "partitions": 42, "transferring": 42 }, "membership_status": "string", "node_id": 42, "num_cores": 42, "rack": "string", "internal_rpc_address": "string", "internal_rpc_port": 42, "version": "string" } ], "version": 42 }