Stay organized with collections Save and categorize content based on your preferences.
Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.
HTTP requestPOST https://sqladmin.googleapis.com/v1/projects/{project}/instances/{instance}/failover
The URL uses gRPC Transcoding syntax.
Path parameters Parametersproject
string
ID of the project that contains the read replica.
instance
string
Cloud SQL instance ID. This does not include the project ID.
Request bodyThe request body contains an instance of InstancesFailoverRequest
.
If successful, the response body contains an instance of Operation
.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/sqlservice.admin
For more information, see the Authentication Overview.
InstancesFailoverRequestInstance failover request.
FieldsfailoverContext
object (
FailoverContext
)
instances.failover Context.
FailoverContextDatabase instance failover context.
JSON representation{ "settingsVersion": string, "kind": string }Fields
settingsVersion
string (int64 format)
The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.
kind
string
This is always sql#failoverContext
.
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-05-30 UTC.
[[["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-05-30 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4