---
title: "Get cluster status info"
method: GET
path: "/cluster"
tags: ["Distributed"]
---

# Get cluster status info

`GET /cluster`

Get information about the current state and composition of the cluster

## Response `200`

successful operation

- object
  - `usage` union
    - Usage — Usage of the hardware resources, spent to process the request
      - `hardware` union
        - HardwareUsage — Usage of the hardware resources, spent to process the request
          - `cpu` integer, required
          - `payload_io_read` integer, required
          - `payload_io_write` integer, required
          - `payload_index_io_read` integer, required
          - `payload_index_io_write` integer, required
          - `vector_io_read` integer, required
          - `vector_io_write` integer, required
        - unknown
      - `inference` union
        - InferenceUsage
          - `models` object, required
        - unknown
    - unknown
  - `time` number, float — Time spent to process this request
  - `status` string
  - `result` union — Information about current cluster status and structure
    - object
      - `status` 'disabled', required
    - object — Description of enabled cluster
      - `status` 'enabled', required
      - `peer_id` integer, required — ID of this peer
      - `peers` object, required — Peers composition of the cluster with main information
      - `raft_info` RaftInfo, required — Summary information about the current raft state
        - `term` integer, required — Raft divides time into terms of arbitrary length, each beginning with an election. If a candidate wins the election, it remains the leader for the rest of the term. The term number increases monotonically. Each server stores the current term number which is also exchanged in every communication.
        - `commit` integer, required — The index of the latest committed (finalized) operation that this peer is aware of.
        - `pending_operations` integer, required — Number of consensus operations pending to be applied on this peer
        - `leader` integer, nullable — Leader of the current term
        - `role` union — Role of this peer in the current term
          - 'Follower' | 'Candidate' | 'Leader' | 'PreCandidate' — Role of the peer in the consensus
          - unknown
        - `is_voter` boolean, required — Is this peer a voter or a learner
      - `consensus_thread_status` union, required — Information about current consensus thread status
        - object
          - `consensus_thread_status` 'working', required
          - `last_update` string, date-time, required
        - object
          - `consensus_thread_status` 'stopped', required
        - object
          - `consensus_thread_status` 'stopped_with_err', required
          - `err` string, required
      - `message_send_failures` object, required — Consequent failures of message send operations in consensus by peer address. On the first success to send to that peer - entry is removed from this hashmap.

## Other responses

- `default` — error
- `4XX` — error

---

[API](https://skmtc.net/qdrant/apis/qdrant-api.md) · [All operations](https://skmtc.net/qdrant/apis/qdrant-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qdrant/qdrant-api/revisions/d08b1f613f29/schema)