批量查询容灾实例信息

功能介绍

批量查询容灾实例信息。

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

接口约束

仅RDS for PostgreSQL 12支持建立跨云或跨Region容灾关系，且功能正在公测。

URI

• URI格式

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

• 参数说明

  表1 参数说明

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

请求消息

• 参数说明

  无。

• URI样例

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

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  instance_dr_relations	Array of objects	容灾实例信息列表。 详情请参见表3。

  表3 instance_dr_relations字段数据结构说明

  名称	参数类型	说明
  instance_id	String	当前区域实例ID。
  master_instance	Object	主实例信息。 详情请参见表4。
  slave_instances	Array of objects	容灾实例信息列表。 详情请参见表5。

  表4 master_instance字段数据结构说明

  名称	参数类型	说明
  instance_id	String	实例ID。
  region	String	区域。
  project_id	String	项目ID。
  project_name	String	项目名称。

  表5 slave_instances字段数据结构说明

  名称	参数类型	说明
  instance_id	String	实例ID。
  region	String	区域。
  project_id	String	项目ID。
  project_name	String	项目名称。

• 正常响应样例

  {
     "instance_dr_relations": [
        {
           "instance_id": "b5e2c7fcef8b4c2f8fd8d80d73344756in03",
           "master_instance": {
              "instance_id": "fab4e3df67c24aa0a5b41bc2bcb41918in03",
              "region": "aRegion",
              "project_id": "08fd4e669e00d57d2ffec01352c7cb77",
              "project_name": "masterProjectName"
           }
        },
        {
           "instance_id": "fab4e3df67c24aa0a5b41bc2bcb41918in03",
           "slave_instances": [
              {
                 "instance_id": "b5e2c7fcef8b4c2f8fd8d80d73344756in03",
                 "region": "bRegion",
                 "project_id": "054b61972980d4552f0bc00ac8d3f5cd",
                 "project_name": "slaveProjectName"
              }
           ]
        }
     ]
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。