Querying the Switchover Result¶

Function¶

This API is used to query the dual-virtual IP address switchover result.

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

GET /v3/{project_id}/jobs/{job_id}/get-switch-vip-status

**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

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
id	String	Task ID.
status	String	Status Values: SWITCH_VIP_COMPLETE: The switchover is successful. SWITCH_VIP_FAILED: The switchover failed. SWITCH_VIP_START: The switchover is in progress.
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/260e27fd-4976-44dc-9948-e1265e4jb201/get-switch-vip-status

Status code: 200

Accepted

{
    "id": "260e27fd-4976-44dc-9948-e1265e4jb201",
    "status": "SWITCH_VIP_COMPLETE"
}

Status Code	Description
200	OK
400	Bad Request

For details, see Error Code.

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