Promote Read Replica — API

Path parameters

Cluster_idPathintegerrequired
Cluster Id
instance_idPathintegerrequired
Unique identifier of the DBaaS instance

Query parameters

project_idQueryintegerrequired
Project ID Find your project id here
locationQuerystringrequired
Location (Delhi and Chennai)

Request body

application/json

object

namestringrequired

Name of the DBaaS instance to be promoted during failover

groupstringrequired

Instance group name

public_ip_requiredbooleanrequired

Whether a public IP should be assigned after failover

template_idintegerrequired

Template ID to be used during failover

Responses

200Failover operation initiated successfully

object

codeintegerrequired

example200

dataobjectrequired

errorsobjectrequired

messagestringrequired

exampleFailover initiated successfully

Request

curl -X POST 'https://api.e2enetworks.com/myaccount/rds/cluster/{Cluster_id}/instance/{instance_id}/failover/?project_id=%3Cproject_id%3E&location=%3Clocation%3E&apikey=%3Capikey%3E' \
  -H 'Authorization: Bearer <JWT>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "group": "string",
  "public_ip_required": false,
  "template_id": 0
}'

Response · 200

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