
# 查询可用于搭建容灾的主实例或灾备实例 - ShowAvailableBuildDrInstance
#### 功能介绍
查询可用于搭建容灾的主实例或灾备实例。
- 调用接口前，您需要了解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=ShowAvailableBuildDrInstance)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                  | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:listAll | read | -           | -   | rds:instance:list | -      |
   
#### 接口约束
该接口目前仅支持RDS for PostgreSQL引擎。
#### URI
- URI格式 GET /v3/{project_id}/instances/disaster-recovery-instance?type={type}
  
- 参数说明
  表1参数说明 
  | 参数         | 是否必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  |:---|:---|:---|
  | project_id | 是    | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
  | type       | 是    | **参数解释：** 要查询的实例类型。 **约束限制：** 非空。 **取值范围：** - master：主实例。  - slave：灾备实例。   **默认取值** **：** 不涉及。                                                                                                |
     
  
 
#### 请求消息
无。
#### 请求示例
查询可用于搭建容灾的主实例或灾备实例。
```
GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/disaster-recovery-instance?type=master
```
#### 响应消息
- 正常响应要素说明
  表2参数说明 
  | 参数        | 参数类型             | 描述                                                                                                                                                       |
  |:---|:---|:---|
  | instances | Array of objects | **参数解释：** 实例信息列表。 详情请参见[表3]。 |
     
   表3instances字段说明 
  | 参数            | 参数类型   | 描述                                                                                                                                                                                     |
  |:---|:---|:---|
  | instance_id   | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 |
  | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 |
     
  

- 正常响应样例
  ```
  {
   "instances": [
          {
          "instance_id": "fab4e3df67c24aa0a5b41bc2bcb41918in03",
          "instance_name": "rds-test1"
           },
          {
          "instance_id": "b5e2c7fcef8b4c2f8fd8d80d73344756in03",
          "instance_name": "rds-test2"
         }
      ]
  }
  ```
  
- 异常响应 请参见[异常响应结果](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)。
