Create a shard key

PUT
Creates one or more shard keys for a specified collection.

Path parameters

collection_namestringRequired
Name of the collection to create shards for

Query parameters

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

Request

This endpoint expects an object.
shard_keystring or integerRequired
shards_numberintegerOptional
How many shards to create for this key If not specified, will use the default value from config
replication_factorintegerOptional
How many replicas to create for each shard If not specified, will use the default value from config
placementlist of integersOptional
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

Response

This endpoint returns an object.
timedoubleOptional
Time spent to process this request
statusstringOptional
resultbooleanOptional
Built with