# 手动倒换主备 - StartFailover
#### 功能介绍
您可以根据业务需要，手动倒换主备实例。
- 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。
- 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=StartFailover)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                     | 访问级别  | 资源类型（\*为必须） | 条件键                                                                          | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:switchover | write | instance    | g:EnterpriseProjectId g:ResourceTag/\<tag-key\> | -  | -      |
   
#### 接口约束
- 仅支持HA实例。
- 实例在创建、重启、数据库升级、变更规格、恢复、修改端口、删除用户、创建用户时不能进行此操作。
- 主备倒换不会改变实例的内网地址。
 
#### URI
- URI格式 PUT /v3/{*project_id* }/instances/{*instance_id*}/failover
  

- 参数说明
  表1参数说明 
  | 名称          | 是否必选 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  |:---|:---|:---|
  | project_id  | 是    | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                 |
  | instance_id | 是    | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求消息
表2参数说明 
| 名称    | 是否必选 | 参数类型    | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| force | 否    | Boolean | **参数解释：** 是否强制倒换主备实例。 **约束限制**： 该参数仅对PostgreSQL引擎有效。 **取值范围**： - true：强制倒换。  - false：不强制倒换。   **默认取值**： 默认为空，表示不强制倒换。 |
   
#### 请求示例
- 不强制倒换主备实例。
  ```
  PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover
  {}
  ```
  
- 强制倒换主备实例。
  ```
  {
  "force":true
  }
  ```
  
 
#### 响应消息
- 正常响应要素说明
  
  | 名称         | 参数类型   | 说明                                                                                                                       |
  |:---|:---|:---|
  | workflowId | String | **参数解释：** 任务ID。 **取值范围**： 不涉及。  |
  | instanceId | String | **参数解释：** 实例ID。 **取值范围**： 不涉及。 |
  | nodeId     | String | **参数解释：** 节点ID。 **取值范围**： 不涉及。  |
     
  

- 正常响应样例
  ```
  {
      "workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a",
      "instanceId":"794c38e5309344818f4b33b86ebce9b4in03",
      "nodeId":"b94ba815747040f1b0d641cd13364a06no03"
  }
  ```
  
- 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
  
 
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。