Distributed

Retrieve cluster details

GET
Retrieves cluster details for a specified collection.

Path parameters

collection_namestringRequired
Name of the collection to retrieve the cluster info for

Response

This endpoint returns an object
time
doubleOptional
Time spent to process this request
status
stringOptional
result
objectOptional
Current clustering distribution for the collection
GET
1curl http://localhost:6333/collections/collection_name/cluster \
2 -H "api-key: <apiKey>"
200Retrieved
1{
2 "time": 1.1,
3 "status": "status",
4 "result": {
5 "peer_id": 1,
6 "shard_count": 1,
7 "local_shards": [
8 {
9 "shard_id": 1,
10 "points_count": 1,
11 "state": "Active"
12 }
13 ],
14 "remote_shards": [
15 {
16 "shard_id": 1,
17 "peer_id": 1,
18 "state": "Active"
19 }
20 ],
21 "shard_transfers": [
22 {
23 "shard_id": 1,
24 "from": 1,
25 "to": 1,
26 "sync": true
27 }
28 ]
29 }
30}