Promote Read Replica

POST

/api/v1/rds/cluster/{Cluster_id}/instance/{instance_id}/failover/

curl --request POST \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/rds/cluster/{Cluster_id}/instance/{instance_id}/failover/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "E2E-DBaaS-26321-2331",
  "group": "Default",
  "public_ip_required": true,
  "template_id": 21
}'

Parameters

Path Parameters

Cluster_id

required

integer

Cluster Id

instance_id

required

integer

Example

17916

Unique identifier of the DBaaS instance

Query Parameters

project_id

required

integer

Project ID Find your project id here

location

required

string

Allowed values: Delhi Chennai

Deployment region for the resource. Accepted values: Delhi, Chennai.

Mumbai region has been discontinued. Delhi and Chennai are the only supported regions.

Request Body^required

Media typeapplication/json

object

name

required

Name of the DBaaS instance to be promoted during failover

string

group

required

Instance group name

string

public_ip_required

required

Whether a public IP should be assigned after failover

boolean

template_id

required

Template ID to be used during failover

integer

Example

{
  "name": "E2E-DBaaS-26321-2331",
  "group": "Default",
  "public_ip_required": true,
  "template_id": 21
}

Responses

200

Failover operation initiated successfully

Media typeapplication/json

object

code

required

integer

data

required

object

message

required

string

cluster_id

required

integer

instance_id

required

integer

errors

required

object

message

required

string

Example

{
  "code": 200,
  "data": {
    "message": "Failover initiated successfully",
    "cluster_id": 8475,
    "instance_id": 17916
  },
  "errors": {},
  "message": "Failover initiated successfully"
}