Method: projects.locations.autonomousDatabases.failover

Initiates a failover to target autonomous database from the associated primary database.

HTTP request

POST https://oracledatabase.googleapis.com/v1/{name=projects/*/locations/*/autonomousDatabases/*}:failover

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomousDatabase}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "peerAutonomousDatabase": string
}
Fields
peerAutonomousDatabase

string

Required. The peer database name to fail over to.

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.

IAM Permissions

Requires the following IAM permission on the name resource:

  • oracledatabase.autonomousDatabases.failover

For more information, see the IAM documentation.