---
title: "Collection cluster info"
method: GET
path: "/collections/{collection_name}/cluster"
tags: ["Distributed"]
---

# Collection cluster info

`GET /collections/{collection_name}/cluster`

Get cluster information for a collection

## Path parameters

- `collection_name` string, required

## Response `200`

successful operation

- object
  - `usage` 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
  - `time` number, float — Time spent to process this request
  - `status` string
  - `result` CollectionClusterInfo — Current clustering distribution for the collection
    - `peer_id` integer, required — ID of this peer
    - `shard_count` integer, required — Total number of shards
    - `local_shards` LocalShardInfo[], required — Local shards
      - `shard_id` integer, required — Local shard id
      - `shard_key` union — User-defined sharding key
        - union
          - string
          - integer
        - unknown
      - `points_count` integer, required — Number of points in the shard
      - `state` 'Active' | 'Dead' | 'Partial' | 'Initializing' | 'Listener' | 'PartialSnapshot' | 'Recovery' | 'Resharding' | 'ReshardingScaleDown', required — State of the single shard within a replica set.
    - `remote_shards` RemoteShardInfo[], required — Remote shards
      - `shard_id` integer, required — Remote shard id
      - `shard_key` union — User-defined sharding key
        - union
          - string
          - integer
        - unknown
      - `peer_id` integer, required — Remote peer id
      - `state` 'Active' | 'Dead' | 'Partial' | 'Initializing' | 'Listener' | 'PartialSnapshot' | 'Recovery' | 'Resharding' | 'ReshardingScaleDown', required — State of the single shard within a replica set.
    - `shard_transfers` ShardTransferInfo[], required — Shard transfers
      - `shard_id` integer, required
      - `to_shard_id` integer, nullable — Target shard ID if different than source shard ID Used exclusively with `ReshardStreamRecords` transfer method.
      - `from` integer, required — Source peer id
      - `to` integer, required — Destination peer id
      - `sync` boolean, required — If `true` transfer is a synchronization of a replicas If `false` transfer is a moving of a shard from one peer to another
      - `method` union
        - union — Methods for transferring a shard from one node to another.
          - 'stream_records' — Stream all shard records in batches until the whole shard is transferred.
          - 'snapshot' — Snapshot the shard, transfer and restore it on the receiver.
          - 'wal_delta' — Attempt to transfer shard difference by WAL delta.
          - 'resharding_stream_records' — Shard transfer for resharding: stream all records in batches until all points are transferred.
        - unknown
      - `comment` string, nullable — A human-readable report of the transfer progress. Available only on the source peer.
    - `resharding_operations` ReshardingInfo[], nullable — Resharding operations
      - `direction` union, required — Resharding direction, scale up or down in number of shards
        - 'up' — Scale up, add a new shard
        - 'down' — Scale down, remove a shard
      - `shard_id` integer, required
      - `peer_id` integer, required
      - `shard_key` union
        - union
          - string
          - integer
        - unknown

## Other responses

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

## Changes

- **2025-04-15** `5d330acca4cd` — 2 breaking, 6 info
  - removed the required property `usage/anyOf[#/components/schemas/HardwareUsage]/io_read` from the response with the `200` status
  - removed the required property `usage/anyOf[#/components/schemas/HardwareUsage]/io_write` from the response with the `200` status
  - added the required property `usage/anyOf[#/components/schemas/HardwareUsage]/payload_index_io_read` to the response with the `200` status
  - added the required property `usage/anyOf[#/components/schemas/HardwareUsage]/payload_index_io_write` to the response with the `200` status
  - …4 more
- **2025-01-17** `a7900f38a79d` — 1 breaking, 5 warning, 5 info
  - added `subschema #4` to the `result/shard_transfers/items/method/anyOf[#/components/schemas/ShardTransferMethod]/` response property `oneOf` list for the response status `200`
  - removed the optional property `result/resharding_operations/items/comment` from the response with the `200` status
  - added the new `Resharding` enum value to the `result/local_shards/items/state` response property for the response status `200`
  - added the new `Resharding` enum value to the `result/remote_shards/items/state` response property for the response status `200`
  - …7 more
- **2024-10-13** `32595103f462` — 2 breaking
  - the response property `result/resharding_operations` became nullable for the status `200`
  - the response property `result/resharding_operations` became optional for the status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/qdrant/apis/qdrant-api/changes/collections/:collection_name/cluster/get.md)

---

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