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.

usageobject or anyOptional

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   "usage": {
3     "cpu": 1,
4     "io_read": 1,
5     "io_write": 1
6   },
7   "time": 0.002,
8   "status": "ok",
9   "result": {
10     "peer_id": 1,
11     "shard_count": 1,
12     "local_shards": [
13       {
14         "shard_id": 1,
15         "points_count": 1,
16         "state": "Active",
17         "shard_key": "region_1"
18       }
19     ],
20     "remote_shards": [
21       {
22         "shard_id": 1,
23         "peer_id": 1,
24         "state": "Active",
25         "shard_key": "region_1"
26       }
27     ],
28     "shard_transfers": [
29       {
30         "shard_id": 1,
31         "from": 1,
32         "to": 1,
33         "sync": true
34       }
35     ],
36     "resharding_operations": [
37       {
38         "direction": "up",
39         "shard_id": 1,
40         "peer_id": 1,
41         "shard_key": "region_1"
42       }
43     ]
44   }
45 }

Update cluster setup

Up Next

Built with

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

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