Performing a Primary/Secondary Switchover

Function

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

Constraints

This API is available only for replica set and cluster instances.
This operation cannot be performed on frozen or abnormal instances.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
dds:instance:switchover	write	instance	g:EnterpriseProjectId	-	-

URI

URI format
POST /v3/{project_id}/instances/{instance_id}/switchover

**Table 1** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	string	path	Definition 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. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Name	Type	Mandatory	Description
group_id	String	No	Definition Group ID. Constraints N/A Range For a cluster instance, this parameter is set to the ID of the shard or config group. You can call the API used for querying instances and details to obtain the value. This parameter is not specified for replica set instances. Default Value N/A

Response Parameters

**Table 4** Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	Definition The task ID. Range N/A

Example Request

Performing a primary/secondary switchover in the replica set instance whose ID is 9136fd2a9fcd405ea4674276ce36dae8in02
```
https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switchover
```
Performing a primary/secondary switchover in the shard group whose ID is c92d1218bc6b4131bdbeebbff6a2b7fbgr02 of the cluster instance whose ID is e73893ef73754465a8bd2e0857bbf13ein02
```
https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein02/switchover 
   
{
    "group_id" : "c92d1218bc6b4131bdbeebbff6a2b7fbgr02"  
}
```

Example Response

{
    "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.