# 配置灾备实例容灾能力 - StartInstanceSlaveDrAction
#### 功能介绍
实例建立跨云或跨Region容灾关系时配置灾备实例的容灾能力。
- 调用接口前，您需要了解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=StartInstanceSlaveDrAction)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### 接口约束
- 使用该功能前，必须要确保跨云或跨Region数据库实例之间VPC网段的网络打通，且配置安全组放通VPC网段间的数据库端口。仅打通网络未放通安全组也无法搭建容灾关系。
- 主实例配置容灾能力成功后才能配置灾备实例容灾能力，否则容灾关系会建立失败。
- 主实例和灾备实例状态正常，主实例和灾备实例在不同云或不同Region且灾备实例为单实例。
- 灾备实例的CPU和内存规格以及磁盘容量要大于或等于主实例的规格以及磁盘容量。
- 灾备实例的底层架构和数据库大版本要与主实例一致。
- 如果灾备实例与主实例的小版本不一致，则在灾备搭建完成后，会自动重置灾备实例小版本，并与主实例的小版本保持一致。
- 不支持跨大版本建立跨云或跨Region容灾关系。
- 调用配置灾备实例容灾接口后直至成功搭建容灾关系，不能进行规格变更、主备倒换操作。
- RDS for PostgreSQL 12及以上版本支持建立跨云或跨Region容灾关系。
- 灾备实例搭建成功后，不能进行小版本升级。
- 主实例参数被修改后，灾备实例无法同步修改该参数，需结合业务自行修改灾备实例参数。
- RDS for PostgreSQL灾备实例不支持PITR恢复和CBR快照备份功能，如需使用此功能，请在主实例上完成。
 
#### URI
- URI格式 POST /v3/{project_id}/instances/{instance_id}/action
  
- 参数说明
  表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参数说明 
| 名称                      | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| build_slave_dr_relation | 是    | Object | **参数解释**： 配置容灾实例灾备关系所需要的主实例信息。 详情请参见[表3]。 **约束限制**： 不涉及。 |
   
 表3build_slave_dr_relation字段数据结构说明 
| 名称                 | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| target_instance_id | 是    | String | **参数解释**： 主实例的实例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"获取。 **默认取值**： 不涉及。                 |
| target_project_id  | 是    | String | **参数解释**： 主实例所在租户的项目ID。 **约束限制**： 不涉及。 **取值范围**： 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **默认取值**： 不涉及。                                                                                                                                       |
| target_region      | 是    | String | **参数解释**： 主实例所在的区域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)中的"region"获取。 **默认取值**： 不涉及。                      |
| target_ip          | 是    | String | **参数解释**： 主实例的数据虚拟IP（数据VIP）。 **约束限制**： 不涉及。 **取值范围**： 该参数值可调用[查询数据库实例列表](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)中的"private_ips"获取。 **默认取值**： 不涉及。          |
| target_port        | 否    | String | **参数解释**： 主实例的数据库端口。 **约束限制**： 如果主实例端口有改动，请填写修改后的数据库端口。 **取值范围**： 该参数值可调用[查询数据库实例列表](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)中的"port"获取。 **默认取值：** 5432 |
   
#### 请求示例
配置容灾实例灾备关系，主实例所在的区域为aaa。
```
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/action 
{
    "build_slave_dr_relation": {
           "target_instance_id":"c39bd176fb0540929f6add80b91b212cin03",
           "target_project_id":"054b61972980d4552f0bc00ac8d3f5cd",
           "target_region":"aaa",
           "target_ip":"192.168.3.238",
           "target_port":"5433"
     }
}
```
#### 响应消息
- 正常响应要素说明
  表4要素说明 
  | 名称     | 参数类型   | 说明                                                                                                                         |
  |:---|:---|:---|
  | job_id | String | **参数解释**： 工作流ID。 **取值范围**： 不涉及。 |
     
  

- 正常响应样例
  ```
  {
  "job_id": "184f29cd-be1a-43f1-5b6bc5500e73"
  }
  ```
  
- 异常响应 请参见[异常响应结果](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)。