Method: projects.locations.clusters.instances.failover

Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.

HTTP request

POST https://alloydb.googleapis.com/v1/{name=projects/*/locations/*/clusters/*/instances/*}:failover

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.