v17

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-2575397522.8 KB
Distributed

Update collection cluster setup

post/collections/{collection_name}/cluster

Path parameters

collection_namestring required

Name of the collection on which to to apply the cluster update operation

Query parameters

timeoutinteger

Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "create_sharding_key": {
    "shard_key": "region_1"
  }
}

Response

successful operation

timenumber float

Time spent to process this request

statusstring
resultboolean

Example response

{
  "time": 0.002,
  "status": "ok"
}