Method: projects.locations.instances.promoteReplica

Promote the standby instance (replica).

HTTP request

POST https://file.googleapis.com/v1/{name=projects/*/locations/*/instances/*}:promoteReplica

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "peerInstance": string
}
Fields
peerInstance

string

Optional. The resource name of the peer instance to promote, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}. The peer instance is required if the operation is called on an active instance.

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.