
# 搭建容灾关系 - EstablishingaDRRelationship
#### 功能介绍
搭建容灾关系。
- 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。
- 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
 
#### 约束限制
从主实例端下发。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforopenGauss/doc?api=CreateCrossCloudConstructDisaster)中调试该接口。
#### URI
POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/construct
表1参数说明 
| 名称          | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| instance_id | 是    | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 |
| X-Language   | 否    | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文  - **en-us**：英文   **默认取值** **：** **en-us**                     |
   
表3参数说明 
| 名称               | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| disaster_type    | 是    | String | **参数解释：** 容灾类型。 **约束限制：** 不涉及。 **取值范围：** - stream：流式容灾。   **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                               |
| dr_ip            | 是    | String | **参数解释：** 对端实例数据IP。可通过[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取。 - 集中式版：对端实例任意节点数据IP（非仲裁节点、非日志节点）。  - 分布式版：对端实例CN节点的数据IP。   **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 |
| dr_user_name     | 是    | String | **参数解释：** 对端实例账户名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| dr_user_password | 是    | String | **参数解释：** 对端实例账户密码。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| dr_task_name     | 否    | String | **参数解释：** 容灾任务名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
   
#### 响应参数
表4响应Body参数列表 
| 名称     | 参数类型   | 说明                                                                                                                                                                                                                          |
|:---|:---|:---|
| job_id | String | **参数解释：** 任务ID。 **取值范围** **：** 长度为36个字符，由英文字母、数字和中划线组成。 |
   
#### 请求示例
```
POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/9089bbf7377442daa55bc28d514c08bdin14/disaster-recovery/construct
{ 
   "disaster_type" : "stream", 
   "dr_ip" : "127.0.0.1", 
   "dr_user_name" : "root", 
   "dr_user_password" : "password",
   "dr_task_name": "dr-task-123" 
 }
```
#### 响应示例
```
{
"job_id":"8bf0175e-562e-45f6-942a-2e2c72c577d7"
}
```
#### 状态码
- 正常 202
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。
