replication

Retrieve a replication operation

Fetches the current status and detailed information for a specific replication operation, identified by its unique ID. Optionally includes historical data of the operation's progress if requested.

get/replication/replicate/{id}

Request

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

Path parameters

idstring uuid required

The ID of the replication operation to get details for.

Query parameters

includeHistoryboolean

Whether to include the history of the replication operation.

Response

The details of the replication operation.

idstring uuid required

The unique identifier (ID) of this specific replication operation.

shardstring required

The name of the shard involved in this replication operation.

collectionstring required

The name of the collection to which the shard being replicated belongs.

sourceNodestring required

The identifier of the node from which the replica is being moved or copied (the source node).

targetNodestring required

The identifier of the node to which the replica is being moved or copied (the target node).

type'COPY' | 'MOVE' required

Indicates whether the operation is a COPY (source replica remains) or a MOVE (source replica is removed after successful transfer).

uncancelableboolean

Whether the replica operation can't be cancelled.

scheduledForCancelboolean

Whether the replica operation is scheduled for cancellation.

scheduledForDeleteboolean

Whether the replica operation is scheduled for deletion.

whenStartedUnixMsinteger

The UNIX timestamp in ms when the replication operation was initiated. This is an approximate time and so should not be used for precise timing.

Changes

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