Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Performing a Primary/Standby Switchover

Updated on 2025-09-16 GMT+08:00

View PDF

Performing a Primary/Standby Switchover

This API is used to switch the primary and standby of a GeminiDB Redis instance.

This API supports the following instance type:

PUT /v3/{project_id}/instance/{instance_id}/switchover

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A
instance_id	Yes	String	Explanation: Instance ID. Constraints: N/A Values: N/A Default value: N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token. Constraints: N/A Values: N/A Default value: N/A

Status code: 202

**Table 3** Response body parameters
Parameter	Type	Description
job_id	String	Explanation: Task ID. Values: N/A

PUT https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/instance/f42ecf40870644b288884742bff6ef51in12/switchover

Status code: 202

Accepted.

{ 
   "job_id" : "528747ac-c30b-4904-a4ed-806c6943ec96" 
 }

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Instances

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.