- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- DataProtectionMode
- Examples
- Try it!
Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
HTTP request
POST https://redis.googleapis.com/v1/{name=projects/*/locations/*/instances/*}:failover
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. Redis instance resource name using the form: |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"dataProtectionMode": enum ( |
Fields | |
---|---|
dataProtectionMode |
Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default. |
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.
DataProtectionMode
Specifies different modes of operation in relation to the data retention.
Enums | |
---|---|
DATA_PROTECTION_MODE_UNSPECIFIED |
Defaults to LIMITED_DATA_LOSS if a data protection mode is not specified. |
LIMITED_DATA_LOSS |
Instance failover will be protected with data loss control. More specifically, the failover will only be performed if the current replication offset diff between primary and replica is under a certain threshold. |
FORCE_DATA_LOSS |
Instance failover will be performed without data loss control. |