# 切换实例的主备节点-PerformingaPrimary/SecondarySwitchover
#### 功能介绍
切换副本集实例和集群实例下的主备节点。
#### 接口约束
- 该接口支持DDS副本集实例和集群实例。
- 冻结实例，异常实例不支持该操作。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=SwitchoverReplicaSet)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                     | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                              | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:instance:switchover | write | instance    | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | -  | -      |
     
  
 
#### URI
- URI格式 POST /v3/{project_id}/instances/{instance_id}/switchover
  
 
表1路径参数 
| 名称          | 是否必选 | 类型     | IN   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|:---|
| project_id  | 是    | string | path | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                |
| instance_id | 是    | string | path | **参数解释：** 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 名称           | 是否必选 | 类型     | IN     | 描述                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|:---|
| X-Auth-Token | 是    | string | header | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表3请求Body参数 
| 名称       | 参数类型   | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| group_id | String | 否    | **参数解释** 组ID。 **约束限制** 不涉及。 **取值范围** - 对于集群实例，该参数为shard组ID或config组ID。可以调用"[查询实例列表和详情](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。  - 对于副本集实例，不传该参数。   **默认取值** 不涉及。 |
   
#### 响应参数
表4参数说明 
| 名称     | 参数类型   | 是否必选 | 描述                                                                                                                      |
|:---|:---|:---|:---|
| job_id | String | 是    | **参数解释：** 任务ID。 **取值范围：** 不涉及。 |
   
#### 请求示例
- 切换副本集实例9136fd2a9fcd405ea4674276ce36dae8in02的主备节点
  ```
  POST https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switchover
  ```
  
- 切换集群实例e73893ef73754465a8bd2e0857bbf13ein02的shard组c92d1218bc6b4131bdbeebbff6a2b7fbgr02中的主备节点
  ```
  POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein02/switchover 
     
  {
      "group_id" : "c92d1218bc6b4131bdbeebbff6a2b7fbgr02"  
  }
  ```
  
 
#### 响应示例
```
{
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}
```
#### SDK
单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
#### 状态码
详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。
#### 错误码
详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。