Promoting a Read Replica to Primary
Function
This API is used to promote a read replica to the primary node. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
PUT /v3/{project_id}/instances/{instance_id}/switchover
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
|
instance_id |
Yes |
String |
Instance ID of a tenant in a project. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value. |
|
X-Language |
No |
String |
Request language type. The default value is en-us. Value:
|
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
node_id |
Yes |
String |
ID of the read replica that will be promoted to the primary. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
job_id |
String |
Task ID. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Request
Promoting a read replica to primary
PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/switchover
{
"node_id" : "1801a615b52b4a5697cfe385f6affbf4no07"
}
Example Response
Status code: 200
Success.
{
"job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
}
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
