更新时间:2025-08-11 GMT+08:00

查询容灾关系列表

功能介绍

查询容灾关系列表。

URI

GET /v3.5/{project_id}/disaster-recovery/relations

表1 参数说明

名称

参数类型

是否必选

说明

project_id

String

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_name

String

参数解释:

实例名称,可查询过滤本端实例。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,可查询过滤本端实例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 响应Body参数列表

名称

参数类型

说明

total

Integer

参数解释:

总记录数。

取值范围:

不涉及。

relations

Array of Objects

参数解释:

容灾关系详情。详情请参见表3

表3 relations字段数据结构说明

名称

参数类型

说明

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实例信息。详情请参见表4

master_region_instance_info

Object

参数解释:

主Region实例信息。详情请参见表5

synchronization_id

String

参数解释:

容灾关系唯一ID。

取值范围:

不涉及。

id

String

参数解释:

容灾记录ID。

取值范围:

不涉及。

instance_id

String

参数解释:

当前Region实例ID。

取值范围:

不涉及。

instance_name

String

参数解释:

当前Region实例名称。

取值范围:

不涉及。

instance_status

String

参数解释:

当前Region实例状态。

取值范围:

不涉及。

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列表。

表4 slave_region_instance_info字段数据结构说明

名称

参数类型

说明

instance_id

String

参数解释:

实例ID。

取值范围:

不涉及。

project_id

String

参数解释:

实例项目ID。

取值范围:

不涉及。

project_name

String

参数解释:

实例项目名称。

取值范围:

不涉及。

region_code

String

参数解释:

regionCode编码。

取值范围:

不涉及。

ip_address

String

参数解释:

数据IP地址列表,使用英文逗号分隔。

取值范围:

不涉及。

表5 master_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.ap-southeast-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-16 09:39:51", 
     "updated" : "2022-06-16 09:44:55", 
     "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" : "normal", 
     "actions" : [ "STREAM_DISASTER_RELATION_MASTER_TAG" ] 
   } ] 
 }

状态码

错误码

请参见错误码