Method: projects.locations.instances.pauseReplica

Pause the standby instance (replica). WARNING: This operation makes the standby instance's NFS filesystem writable. Any data written to the standby instance while paused will be lost when the replica is resumed or promoted.

HTTP request

POST https://file.googleapis.com/v1beta1/{name=projects/*/locations/*/instances/*}:pauseReplica

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.