Method: projects.locations.environments.databaseFailover

Triggers database failover (only for highly resilient environments).

HTTP request

POST https://composer.googleapis.com/v1/{environment=projects/*/locations/*/environments/*}:databaseFailover

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
environment

string

Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Authorization requires the following IAM permission on the specified resource environment:

  • composer.environments.update

Request body

The request body must be empty.

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.