文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 灾备实例/ 配置主实例容灾能力
更新时间：2024-05-29 GMT+08:00
查看PDF
分享

配置主实例容灾能力

功能介绍

建立跨云或跨Region容灾关系时配置主实例的容灾能力。

使用该功能前，必须要确保跨云或跨Region数据库实例之间VPC网段的网络打通，且配置安全组放通VPC网段间的数据库端口。仅打通网络未放通安全组也无法搭建容灾关系。

调试

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

接口约束

  • 主实例和灾备实例状态正常，主实例和灾备实例在不同云或不同Region上，且主实例为主备实例，灾备实例为单实例。
  • 灾备实例的规格要大于等于主实例的规格。
  • 灾备实例的底层架构和数据库大版本要与主实例一致。
  • 调用配置主实例容灾接口后直至成功搭建容灾关系，不能进行规格变更、主备倒换操作。
  • RDS for PostgreSQL 12及以上版本支持建立跨云或跨Region容灾关系。
  • 不支持跨大版本建立跨云或跨Region容灾关系。

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/action

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

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

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

    instance_id

    是

    实例ID。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

build_master_dr_relation

是

Object

配置主实例灾备关系所需要的灾备实例信息。

详情请参见表3。
表3 build_master_dr_relation字段数据结构说明

名称

是否必选

参数类型

说明

target_instance_id

是

String

灾备实例的实例ID。

target_project_id

是

String

灾备实例所在租户的项目 ID。

target_region

是

String

灾备实例所在的区域 ID。

target_ip

是

String

灾备实例的数据虚拟IP（数据VIP）。

target_subnet

是

String

灾备实例的子网地址。

请求示例

配置主实例灾备关系，灾备实例所在的区域为aaa。 
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/action 
{
    "build_master_dr_relation": {
           "target_instance_id":"c39bd176fb0540929f6add80b91b212cin03",
           "target_project_id":"054b61972980d4552f0bc00ac8d3f5cd",
           "target_region":"aaa",
           "target_ip":"192.168.3.238",
           "target_subnet":"192.168.3.1/24"
    }
}

响应消息

  • 正常响应要素说明
    表4 要素说明

    名称

    参数类型

    说明

    job_id

    String

    工作流ID。
  • 正常响应样例 
    {
	"job_id": "184f29cd-be1a-43f1-5b6bc5500e73"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 灾备实例

相关文档