v17

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

Distributed

Create shard key

put/collections/{collection_name}/shards

Path parameters

collection_namestring required

Name of the collection to create shards for

Query parameters

timeoutinteger

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

Request body

shards_numberinteger nullable

How many shards to create for this key If not specified, will use the default value from config

replication_factorinteger nullable

How many replicas to create for each shard If not specified, will use the default value from config

placementinteger[] nullable

Placement of shards for this key List of peer ids, that can be used to place shards for this key If not specified, will be randomly placed among all peers

Example request

{
  "shard_key": "region_1"
}

Response

successful operation

timenumber float

Time spent to process this request

statusstring

resultboolean

Example response

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