# 查询容灾关系列表 - QueryingInstancesThatHaveEstablishedaDRRelationship #### 功能介绍 查询容灾关系列表。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforopenGauss/doc?api=ShowCrossCloudDisasterRelations)中调试该接口。 #### URI GET /v3.5/{project_id}/disaster-recovery/relations 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_name | 否 | String | **参数解释：** 实例名称，可查询过滤本端实例。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | instance_id | 否 | String | **参数解释：** 实例ID，可查询过滤本端实例ID。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** 最小值为1，最大值为100。 **默认取值** **：** 为空时，默认为100。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不能为负数。 **取值范围：** 不涉及。 **默认取值** **：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | dr_role | 否 | String | **参数解释：** 容灾角色。 **约束限制：** 不涉及。 **取值范围：** - master：主实例。 - disaster：灾备实例。 **默认取值** **：** 不涉及。 | | dr_type | 否 | String | **参数解释：** 容灾类型。 **约束限制：** 不涉及。 **取值范围：** - stream：流式容灾。 **默认取值** **：** 不涉及。 | | dr_status | 否 | String | **参数解释：** 容灾状态。 **约束限制：** 不涉及。 **取值范围：** - normal：容灾关系正常。 - failover：容灾已升主。 - pending：任务处理中。 - pre_check_failed：容灾预检查失败。 - pre_checking：容灾预检查。 **默认取值** **：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表3响应Body参数列表 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | total | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | relations | Array of Objects | **参数解释：** 容灾关系详情。详情请参见[表4]。 | 表4relations字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | disaster_type | String | **参数解释：** 容灾类型。 **取值范围：** - stream：流式容灾。 | | name | String | **参数解释：** 容灾任务名称。 **取值范围：** 不涉及。 | | disaster_role | String | **参数解释：** 容灾角色。 **取值范围：** - master：主实例。 - disaster：灾备实例。 | | created | String | **参数解释：** 创建时间。 **取值范围：** 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | updated | String | **参数解释：** 更新时间。 **取值范围：** 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | slave_region_instance_info | Object | **参数解释：** 备Region实例信息。详情请参见[表5]。 | | master_region_instance_info | Object | **参数解释：** 主Region实例信息。详情请参见[表6]。 | | synchronization_id | String | **参数解释：** 容灾关系唯一ID。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 容灾记录ID。 **取值范围：** 不涉及。 | | instance_id | String | **参数解释：** 当前Region实例ID。 **取值范围：** 不涉及。 | | instance_name | String | **参数解释：** 当前Region实例名称。 **取值范围：** 不涉及。 | | instance_status | String | **参数解释：** 当前Region实例状态。 **取值范围：** - 值为"BUILD"，表示实例正在创建。 - 值为"BUILD_FAILED"，表示实例创建失败。 - 值为"ACTIVE"，表示实例正常。 - 值为"FAILED"，表示实例异常。 - 值为"FROZEN"，表示实例冻结。 - 值为"MODIFYING"，表示实例正在扩容磁盘或者变更规格。 - 值为"EXPANDING"，表示实例正在添加只读节点或扩容CN或DN。 - 值为"REBOOTING"，表示实例正在重启。 - 值为"REDUCING", 表示实例正在删除只读节点。 - 值为"UPGRADING"，表示实例正在升级。 - 值为"RESTORING"，表示实例正在恢复。 - 值为"SWITCHOVER"，表示实例正在主备切换。 - 值为"MIGRATING"，表示实例正在迁移。 - 值为"BACKING UP"，表示实例正在进行备份。 - 值为"UPGRADE TO BE OBSERVED"，表示实例正在进行升级待观察。 - 值为"MODIFYING DATABASE PORT"，表示实例正在修改数据库端口。 - 值为"STORAGE FULL"，表示实例磁盘空间满。 - 值为"REPAIRING"，表示实例正在修复。 - 值为"SHUTDOWN"，表示实例已停止。 | | precheck_failed_reason | String | **参数解释：** 预校验失败原因。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 容灾记录状态。 **取值范围：** - pending：任务处理中。 - normal：容灾关系正常。 - failed：容灾搭建失败。 - completed：容灾关系已解除。 - failover：容灾已升主。 - simulation：演练中。 - dr_log_keep：日志保持中。 - pre_checking：容灾预检查。 - pre_check_failed：容灾预检查失败。 | | actions | Array of Strings | **参数解释：** 实例当前正在执行的Action列表。 | 表5slave_region_instance_info字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | project_id | String | **参数解释：** 实例项目ID。 **取值范围：** 不涉及。 | | project_name | String | **参数解释：** 实例项目名称。 **取值范围：** 不涉及。 | | region_code | String | **参数解释：** regionCode编码。 **取值范围：** 不涉及。 | | ip_address | String | **参数解释：** 数据IP地址列表，使用英文逗号分隔。 **取值范围：** 不涉及。 | 表6master_region_instance_info字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | project_id | String | **参数解释：** 实例项目ID。 **取值范围：** 不涉及。 | | project_name | String | **参数解释：** 实例项目名称。 **取值范围：** 不涉及。 | | region_code | String | **参数解释：** regionCode编码。 **取值范围：** 不涉及。 | | ip_address | String | **参数解释：** 数据IP地址列表，使用英文逗号分隔。 **取值范围：** 不涉及。 | #### 请求示例 ``` https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/disaster-recovery/relations?limit=&offset=0&instance_name=test ``` #### 响应示例 ``` { "total" : 1, "relations" : [ { "name" : "DR-task-0962", "created" : "2022-06-16T09:39:51+0800", "updated" : "2022-06-16T09:44:55+0800", "id" : "30b74120-4b50-495d-8174-7eeddf7feac5", "synchronization_id" : "9446f822-ccd2-43dc-929c-0b78ba7fdf64", "status" : "normal", "precheck_failed_reason" : "", "disaster_type" : "stream", "disaster_role" : "disaster", "slave_region_instance_info" : { "region_code" : "sa-fb-1", "instance_id" : "d1060faf0d3743dd8830b39e7423bc9ain14", "project_id" : "4a52a8a8f63d4c6d966dff0e20b69738", "project_name" : "sa-fb-1_GaussDB", "ip_address" : "172.166.1.192,172.166.0.6,172.166.1.135" }, "master_region_instance_info" : { "region_code" : "sa-fb-1", "instance_id" : "54d4b9fb131745fcba32cb90a05cabb8in14", "project_id" : "4a52a8a8f63d4c6d966dff0e20b69738", "project_name" : "sa-fb-1_GaussDB", "ip_address" : "172.167.1.86,172.167.0.89,172.167.1.229" }, "instance_id" : "d1060faf0d3743dd8830b39e7423bc9ain14", "instance_name" : "hly-0609-02", "instance_status" : "ACTIVE", "actions" : [ "STREAM_DISASTER_RELATION_MASTER_TAG" ] } ] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。