Update rolling settings #

Adjust the replica count of an existing rolling: every shard group of the rolling gains new unassigned replica shards (allocated by the shard allocator when capacity allows) or has its extra replicas removed, and the rolling’s number_of_replicas setting is updated.

This is the leaf-most level of the layered settings model — it overrides the collection-level default for this rolling only.

Examples #

Scale the rolling 0 of my-collection from 1 to 2 replicas:

PUT /my-collection/_rolling/0/_settings
{
  "number_of_replicas": 2
}

The API returns the following result:

{
  "acknowledged": true,
  "collection": "default:my-collection",
  "rolling_id": 0,
  "number_of_replicas": 2,
  "shard_groups_adjusted": 1
}

Request #

PUT /[<namespace>:]<name>/_rolling/<rolling_id>/_settings

Path Parameters #

• <namespace>
  (Optional, string) The namespace which the collection belongs to.
• <name>
  (Required, string) Name of the collection.
• <rolling_id>
  (Required, integer) The rolling to resize.

Request body #

• number_of_replicas
  (Required, integer, max 32) The new replica count for every shard group of the rolling.

A rolling that is currently being resharded has its replica count frozen until the reshard commits — the request is rejected with 400 in that case (wait for the reshard to finish or cancel it first). A count equal to the current one is also rejected with 400.