replication

Get replication scale plan

Computes and returns a replication scale plan for a given collection and desired replication factor. The plan includes, for each shard, a list of nodes to be added and a list of nodes to be removed.

get/replication/scale

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/replication/scale
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Query parameters

collectionstring required

The collection name to get the scaling plan for.

replicationFactorinteger required

The desired replication factor to scale to. Must be a positive integer greater than zero.

Response

Replication scale plan showing node additions and removals per shard.

planIdstring uuid required

A unique identifier for this replication scaling plan, useful for tracking and auditing purposes.

collectionstring required

The name of the collection to which this replication scaling plan applies.

shardScaleActionsobject required

A mapping of shard names to their corresponding scaling actions. Each key corresponds to a shard name, and its value defines which nodes should be removed and which should be added for that shard. If a source node listed for an addition is also in 'removeNodes' for the same shard, that addition is treated as a move operation. Such a node can appear only once as a source in that shard. Otherwise, if the source node is not being removed, it represents a copy operation and can be referenced multiple times as a source for additions.

Changes

No recorded changes to this operation across all 1 revision of this API.