
# 查询容灾复制状态 - ShowDrReplicaStatus
#### 功能介绍
建立跨云或跨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=ShowDrReplicaStatus)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                           | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:getReplicaStatus | read | -           | -   | rds:instance:list | -      |
   
#### 接口约束
- 使用该功能前，必须要确保跨云或跨Region数据库实例之间VPC网段的网络打通，且配置安全组放通VPC网段间的数据库端口。仅打通网络未放通安全组也无法搭建容灾关系。
- 主实例和灾备实例的容灾关系已建立完成。
- RDS for PostgreSQL 12及以上版本的灾备实例支持查询容灾复制状态。
 
#### URI
- URI格式 GET /v3/{project_id}/instances/{instance_id}/disaster-recovery
  
- 参数说明
  表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_12_0005.html)接口，通过[表5](https://support.huaweicloud.com/api-rds/rds_12_0005.html#rds_12_0005__zh-cn_topic_0000001475398557_table135487485815)中的"instance_id"获取。 **默认取值**： 不涉及。 |
     
  
 
#### 请求消息
- 参数说明 无。
  
- URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/disaster-recovery
  
 
- 请求样例 无。
  
#### 响应消息
- 正常响应要素说明
  表2要素说明 
  | 名称                             | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                         |
  |:---|:---|:---|
  | replica_state                  | String | **参数解释**： 同步状态。 **取值范围**： - 0：表示正常。  - -1：表示异常。   说明： 主实例不存在时，主实例和灾备实例间的复制状态发生异常。 |
  | wal_write_receive_delay_in_mb  | String | **参数解释**： 发送延迟大小（MB），即主实例当前wal日志写入位点与灾备实例当前接收wal日志位点的差值。 **取值范围**： 不涉及。                                                                                                                                                                                                           |
  | wal_write_replay_delay_in_mb   | String | **参数解释**： 端到端延迟大小（MB），即主实例当前wal日志写入位点与灾备实例当前回放wal日志位点的差值。 **取值范围**： 不涉及。                                                                                                                                                                                                           |
  | wal_receive_replay_delay_in_ms | String | **参数解释**： 回放延迟时间（ms），即数据在灾备上回放的延迟时间。 **取值范围**： 不涉及。                                                                                                                                                                                                                              |
     
  
- 正常响应样例
  ```
  {
     "replica_state": "0",    
     "wal_write_receive_delay_in_mb": "10.0",
     "wal_write_replay_delay_in_mb": "10.0",    
     "wal_receive_replay_delay_in_ms": "0"
  }
  ```
  
- 异常响应 请参见[异常响应结果](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)。
