# 查询容灾关系列表 - ListDrInfos #### 功能介绍 查询容灾关系列表。 - 调用接口前，您需要了解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://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListDrInfos)中调试该接口。 #### 授权信息 账号具备所有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 12及以上版本实例支持查询容灾关系列表。 #### URI - URI格式 POST /v3/{project_id}/instances/disaster-recovery-infos - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求消息 表2参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | id | 否 | String | **参数解释**： 容灾关系ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | status | 否 | String | **参数解释**： 容灾搭建状态。 **约束限制**： 不涉及。 **取值范围**： - normal：搭建成功。 - failed：搭建失败。 - running：搭建中。 **默认取值**： 不涉及。 | | master_instance_id | 否 | String | **参数解释**： 主实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | master_region | 否 | String | **参数解释**： 主实例Region。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | slave_instance_id | 否 | String | **参数解释**： 灾备实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | slave_region | 否 | String | **参数解释**： 灾备实例Region。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | create_at_start | 否 | Long | **参数解释**： 创建起始时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | create_at_end | 否 | Long | **参数解释**： 创建结束时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | order | 否 | String | **参数解释**： 排序方式。 **约束限制**： 不涉及。 **取值范围**： - DESC：降序。 - ASC：升序。 **默认取值**： DESC | | sort_field | 否 | String | **参数解释**： 排序字段。 **约束限制**： 不涉及。 **取值范围**： - status：容灾搭建状态。 - time：容灾搭建时间。 - master_region：主实例Region。 - slave_region：灾备实例Region。 **默认取值**： time | | offset | 否 | Integer | **参数解释**： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制**： 不涉及。 **取值范围**： 大于等于0的整数。 **默认取值**： 默认为0。偏移0条数据，表示从第一条数据开始查询。 | | limit | 否 | Integer | **参数解释**： 查询记录数。 **约束限制**： 不涉及。 **取值范围**： \[1, 100\] **默认取值**： 10 | #### 请求示例 ``` 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]。 | 表4instance_dr_infos字段说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | id | String | **参数解释**： 容灾关系ID。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 容灾搭建状态。 **取值范围**： 不涉及。 | | failed_message | String | **参数解释**： 失败消息。 **取值范围**： 不涉及。 | | 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），即数据在灾备上回放的延迟时间。 **取值范围**： 不涉及。 | | 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 } ] } ``` - 异常响应 请参见[异常响应结果](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)。