replication

Apply replication scaling plan

Apply a replication scaling plan that specifies nodes to add or remove per shard for a given collection.

post/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)

Request body

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.

Response

List of replication shard copy operation IDs initiated for the scale operation

operationIdsstring[] required

List of shard copy operation IDs created during scaling.

planIdstring uuid required

The unique identifier of the replication scaling plan that generated these operations.

collectionstring required

The name of the collection associated with this replication scaling plan.

Changes

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