Method: instances.promoteReplica

Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.

HTTP request

POST https://sqladmin.googleapis.com/sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

ID of the project that contains the read replica.
instance

string

Cloud SQL read replica instance name.

Query parameters

Parameters
failover

boolean

Set to true to invoke a replica failover to the DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

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.