Retrieve cluster details

GET

/collections/:collection_name/cluster

GET

/collections/:collection_name/cluster

$ curl http://localhost:6333/collections/collection_name/cluster \
>      -H "api-key: <apiKey>"

200Retrieved

1 {
2   "usage": {
3     "cpu": 1,
4     "payload_io_read": 1,
5     "payload_io_write": 1,
6     "payload_index_io_read": 1,
7     "payload_index_io_write": 1,
8     "vector_io_read": 1,
9     "vector_io_write": 1
10   },
11   "time": 0.002,
12   "status": "ok",
13   "result": {
14     "peer_id": 1,
15     "shard_count": 1,
16     "local_shards": [
17       {
18         "shard_id": 1,
19         "points_count": 1,
20         "state": "Active",
21         "shard_key": "region_1"
22       }
23     ],
24     "remote_shards": [
25       {
26         "shard_id": 1,
27         "peer_id": 1,
28         "state": "Active",
29         "shard_key": "region_1"
30       }
31     ],
32     "shard_transfers": [
33       {
34         "shard_id": 1,
35         "from": 1,
36         "to": 1,
37         "sync": true,
38         "to_shard_id": 1,
39         "method": "stream_records",
40         "comment": "string"
41       }
42     ],
43     "resharding_operations": [
44       {
45         "direction": "up",
46         "shard_id": 1,
47         "peer_id": 1,
48         "shard_key": "region_1"
49       }
50     ]
51   }
52 }

Retrieves cluster details for a specified collection.

Authentication

api-keystring

API Key authentication via header

Path parameters

collection_namestringRequired

Name of the collection to retrieve the cluster info for

Response

successful operation

usageobject or any

timedouble

Time spent to process this request

statusstring

resultobject

Current clustering distribution for the collection