Performing a Switchover¶

Function¶

This API is used to switch over virtual IP addresses.

Only synchronization between self-built databases supports the dual virtual IP address switchover.

POST /v3/{project_id}/jobs/{job_id}/switch-vip

**Table 1** Path parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region.
job_id	Yes	String	Job ID of a tenant in a region. If the task is a cross-AZ task, the parent task ID is used.

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	The content type. The default value is application/json.
X-Auth-Token	Yes	String	User token obtained from IAM.
X-Language	No	String	Request language type Default value: en-us Values: en-us zh-cn

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
mode	Yes	String	Switchover type. Values: source: Switch over the virtual IP address of the source database. target: Switch over the virtual IP address of the destination database.

Status code: 202

**Table 4** Response body parameters¶
Parameter	Type	Description
id	String	Task ID.
status	String	Status Values: success: The task is successful. failed: The task fails.
error_code	String	Error code, which is optional and indicates the returned information about the failure status.
error_msg	String	Error message, which is optional and indicates the returned information about the failure status.

Example of batch primary/standby switchover:

https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/8c81a12f-2581-4424-a3ab-70ed874jb201/switch-vip

{
    "mode": "source"
}

Status code: 202

Accepted

{
    "id": "8c81a12f-2581-4424-a3ab-70ed874jb201",
    "status": "success"
}

Status Code	Description
202	Accepted
400	Bad Request

For details, see Error Code.

last updated: 2025-10-17 08:42 UTC - commit: df6b5c95a8a629a0279273204aa535d6349d8750