Stay organized with collectionsSave and categorize content based on your preferences.
Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.
HTTP request
POST https://alloydb.googleapis.com/v1/{name=projects/*/locations/*/clusters/*}:switchover
Required. The name of the resource. For the required format, see the comment on the Cluster.name field
Authorization requires the followingIAMpermission on the specified resourcename:
alloydb.clusters.switchover
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 ofOperation.
[[["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 operation switches the roles of PRIMARY and SECONDARY clusters, promoting the SECONDARY to PRIMARY and reconfiguring the original PRIMARY to replicate from the new PRIMARY, without data loss.\u003c/p\u003e\n"],["\u003cp\u003eThe operation is performed via an HTTP POST request to a specific URL, which requires the resource name in the correct format and the \u003ccode\u003ealloydb.clusters.switchover\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eAn optional request ID can be included to prevent duplicate operations in case of retries, and the server will retain the request ID for at least 60 minutes.\u003c/p\u003e\n"],["\u003cp\u003eYou can validate the request without executing it by setting the \u003ccode\u003evalidateOnly\u003c/code\u003e field to true in the request body.\u003c/p\u003e\n"],["\u003cp\u003eThe authorization scope required for this operation is \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.clusters.switchover\n\nSwitches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.\n\n### HTTP request\n\n`POST https://alloydb.googleapis.com/v1/{name=projects/*/locations/*/clusters/*}:switchover`\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)."]]
