查询容灾关系列表

功能介绍

查询容灾关系列表。

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

调试

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

接口约束

RDS for PostgreSQL 12及以上版本实例支持查询容灾关系列表。

URI

• URI格式

  POST /v3/{project_id}/instances/disaster-recovery-infos

• 参数说明

  表1 参数说明

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

请求消息

请求示例

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/disaster-recovery-infos
{
     "status":  "normal",
     "order":  "ASC",
     "sort_field":  "time",
     "offset": 0,
     "limit": 10
}

响应消息

• 正常响应要素说明

  表3 要素说明

  名称	参数类型	说明
  total_count	Integer	总记录数。
  instance_dr_infos	Array of objects	容灾信息列表。 详情请参见表4。

  表4 instance_dr_infos字段说明

  名称	参数类型	说明
  id	String	容灾关系ID。
  status	String	容灾搭建状态。
  failed_message	String	失败消息。
  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），即数据在灾备上回放的延迟时间。
  master_instance_id	String	主实例ID。
  master_region	String	主实例所在Region。
  slave_instance_id	String	灾备实例ID。
  slave_region	String	灾备实例所在Region。
  build_process	String	搭建流程。 master，表示配置主实例容灾能力流程。 slave，表示配置灾备实例容灾能力流程。
  time	Long	灾备搭建时间。

• 正常响应样例

  {
      "total_count": 1,
  "instance_dr_infos": [
      {
          "id": "57160f82-e6bb-44bc-80db-0d950d4f3b40",
          "status": "failed",
          "failed_message": "the network is disconnected",
          "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",
          "master_instance_id": "fab4e3df67c24aa0a5b41bc2bcb41918in03",
          "master_region": "region-A",
          "slave_instance_id": "df50adb922ef42a495943b304f8aa551in03",
          "slave_region": " region-B",
          "time": 1702551254685
      }
  ]
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。