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 must be empty.
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/bigqueryhttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-02 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[[["\u003cp\u003eThis webpage details the process of failing over a reservation to a secondary location, which will then become the new primary.\u003c/p\u003e\n"],["\u003cp\u003eThe operation is performed via an HTTP POST request to a specific URL, requiring a defined resource name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this operation must be empty, and it requires \u003ccode\u003ebigquery.reservations.update\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns a \u003ccode\u003eReservation\u003c/code\u003e resource instance in the response body, detailing the updated reservation status.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/bigquery\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,[]]
