Method: googleapis.sqladmin.v1beta4.instances.failover

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.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters
instance

string

Required. Cloud SQL instance ID. This does not include the project ID.
project

string

Required. ID of the project that contains the read replica.
body

object (InstancesFailoverRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
OperationError If the long-running operation finished unsuccessfully.
ResponseTypeError If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of Operation.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- failover:
    call: googleapis.sqladmin.v1beta4.instances.failover
    args:
        instance: ...
        project: ...
        body:
            failoverContext:
                kind: ...
                settingsVersion: ...
    result: failoverResult

JSON

[
  {
    "failover": {
      "call": "googleapis.sqladmin.v1beta4.instances.failover",
      "args": {
        "instance": "...",
        "project": "...",
        "body": {
          "failoverContext": {
            "kind": "...",
            "settingsVersion": "..."
          }
        }
      },
      "result": "failoverResult"
    }
  }
]