Method: projects.locations.reservations.failoverReservation

Fail over a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

HTTP request

POST https://bigqueryreservation.googleapis.com/v1/{name=projects/*/locations/*/reservations/*}:failoverReservation

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of the reservation to failover. E.g., projects/myproject/locations/US/reservations/team1-prod

Authorization requires the following IAM permission on the specified resource name:

  • bigquery.reservations.update

Request body

The request body contains data with the following structure:

JSON representation 
{
  "failoverMode": enum (FailoverMode)
}
Fields
failoverMode

enum (FailoverMode)

Optional. A parameter that determines how writes that are pending replication are handled after a failover is initiated. If not specified, HARD failover mode is used by default.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

FailoverMode

The failover mode when a user initiates a failover on a reservation determines how writes that are pending replication are handled after the failover is initiated.

Enums
FAILOVER_MODE_UNSPECIFIED Invalid value.
SOFT When customers initiate a soft failover, BigQuery will wait until all committed writes are replicated to the secondary. This mode requires both regions to be available for the failover to succeed and prevents data loss.
HARD When customers initiate a hard failover, BigQuery will not wait until all committed writes are replicated to the secondary. There can be data loss for hard failover.