Performing a Primary/Secondary Switchover in a Replica Set Instance

API Description

This API is used to perform a primary/secondary switchover in a replica set instance.

Restrictions

This API supports only DDS replica sets.
This operation cannot be performed on frozen or abnormal instances.

URI

URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switchover
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switchover

Requests

Parameter description

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token obtained from IAM. For details, see Authentication.
project_id	string	path	Yes	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
instance_id	string	path	Yes	Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Responses

Parameter description

**Table 2** Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	The task ID.

Response example

{
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.