For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETCheck cluster status
      • PUTCreate a shard key
      • POSTDelete a shard key
      • POSTRecover cluster state
      • DELRemove peer from cluster
      • GETRetrieve cluster details
      • POSTUpdate cluster setup
LogoLogo
CloudGitHub
API ReferenceDistributed

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    "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        "to_shard_id": 1,
35        "method": "stream_records",
36        "comment": "string"
37      }
38    ],
39    "resharding_operations": [
40      {
41        "direction": "up",
42        "shard_id": 1,
43        "peer_id": 1,
44        "shard_key": "region_1"
45      }
46    ]
47  }
48}
Retrieves cluster details for a specified collection.
Was this page helpful?
Previous

Update cluster setup

Next
Built with

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