Method: projects.locations.volumes.replications.stop

Stop Cross Region Replication.

HTTP request

POST https://netapp.googleapis.com/v1/{name=projects/*/locations/*/volumes/*/replications/*}:stop

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the replication, in the format of projects/{projectId}/locations/{location}/volumes/{volumeId}/replications/{replicationId}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "force": boolean
}
Fields
force

boolean

Indicates whether to stop replication forcefully while data transfer is in progress. Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.

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.

IAM Permissions

Requires the following IAM permission on the name resource:

  • netapp.replications.stop

For more information, see the IAM documentation.