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

successful operation

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

Current clustering distribution for the collection

GET

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

200Retrieved

1 {
2   "time": 0.002,
3   "status": "ok",
4   "result": {
5     "peer_id": 1000000,
6     "shard_count": 1,
7     "local_shards": [
8       {
9         "shard_id": 1,
10         "points_count": 1,
11         "state": "Active",
12         "shard_key": "region_1"
13       }
14     ],
15     "remote_shards": [
16       {
17         "shard_id": 1,
18         "peer_id": 1000000,
19         "state": "Active",
20         "shard_key": "region_1"
21       }
22     ],
23     "shard_transfers": [
24       {
25         "shard_id": 1,
26         "from": 1000000,
27         "to": 1000000,
28         "sync": true
29       }
30     ],
31     "resharding_operations": [
32       {
33         "direction": "up",
34         "shard_id": 1,
35         "peer_id": 1000000,
36         "shard_key": "region_1"
37       }
38     ]
39   }
40 }

Update cluster setup

Up Next

Built with

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

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": {
5	"peer_id": 1000000,
6	"shard_count": 1,
7	"local_shards": [
8	{
9	"shard_id": 1,
10	"points_count": 1,
11	"state": "Active",
12	"shard_key": "region_1"
13	}
14	],
15	"remote_shards": [
16	{
17	"shard_id": 1,
18	"peer_id": 1000000,
19	"state": "Active",
20	"shard_key": "region_1"
21	}
22	],
23	"shard_transfers": [
24	{
25	"shard_id": 1,
26	"from": 1000000,
27	"to": 1000000,
28	"sync": true
29	}
30	],
31	"resharding_operations": [
32	{
33	"direction": "up",
34	"shard_id": 1,
35	"peer_id": 1000000,
36	"shard_key": "region_1"
37	}
38	]
39	}
40	}