查询容灾复制状态

功能介绍

建立跨云或跨Region容灾关系后，查询主实例和灾备实例间的复制状态及延迟。

使用该功能前，必须要确保跨云或跨Region数据库实例之间VPC网段的网络打通，且配置安全组放通VPC网段间的数据库端口。仅打通网络未放通安全组也无法搭建容灾关系。

• 调用接口前，您需要了解API 认证鉴权。

调试

您可以在API Explorer中调试该接口。

接口约束

• 主实例和灾备实例的容灾关系已建立完成。
• RDS for PostgreSQL 12及以上版本的灾备实例支持查询容灾复制状态。

URI

• URI格式

  GET /v3/{project_id}/instances/{instance_id}/disaster-recovery

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  instance_id	是	灾备实例ID。

请求消息

• 参数说明

  无。

• URI样例

  GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/disaster-recovery

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  replica_state	String	同步状态，取值范围是0或-1，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"
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。