Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Authorization requires the following IAM permission on the specified resource name:
alloydb.instances.failover
Request body
The request body contains data with the following structure:
JSON representation
{"requestId": string,"validateOnly": boolean}
Fields
requestId
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly
boolean
Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
Response body
If successful, the response body contains an instance of Operation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-15 UTC."],[[["\u003cp\u003eThis endpoint triggers a failover for a highly available database instance, promoting the standby instance to the new primary.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made via a \u003ccode\u003ePOST\u003c/code\u003e method to a specific URL, requiring a resource name in the path and utilizing gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can include an optional \u003ccode\u003erequestId\u003c/code\u003e to prevent duplicate actions and a \u003ccode\u003evalidateOnly\u003c/code\u003e boolean for pre-execution validation.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful execution of this failover will result in a response body that contains an \u003ccode\u003eOperation\u003c/code\u003e instance.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to use this endpoint requires the \u003ccode\u003ealloydb.instances.failover\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.clusters.instances.failover\n\nForces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.\n\n### HTTP request\n\n`POST https://alloydb.googleapis.com/v1beta/{name=projects/*/locations/*/clusters/*/instances/*}:failover`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/alloydb/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
