接口约束
4.6 灾备实例
4.6.1 配置主实例容灾能力
功能介绍
建立跨云或跨Region容灾关系时配置主实例的容灾能力。
● 调用接口前，您需要了解API 认证鉴权。
调试
您可以在API Explorer中调试该接口。
接口约束
● 主实例和灾备实例状态正常，主实例和灾备实例在不同云或不同Region上，且主 实例为主备实例，灾备实例为单实例。
● 灾备实例的规格要大于等于主实例的规格。
● 调用配置主实例容灾接口后，将会自动重启主实例。
● 仅PostgreSQL 12支持建立跨云或跨Region容灾关系，且功能正在公测。
● 不支持跨大版本建立跨云或跨Region容灾关系。
URI
● URI格式
POST /v3/{project_id}/instances/{instance_id}/action
● URI样例
https://rds.cn-north-1.myhuaweicloud.com/
v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in03/
action
● 参数说明
表4-96 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID。
请求消息
● 参数说明
表4-97 参数说明
名称 是否必选 参数类型 说明
build_master_dr_
relation 是 Object 配置主实例灾备关系所需要
的灾备实例信息。
详情请参见表4-98。
表4-98 build_master_dr_relation 字段数据结构说明
名称 是否必选 参数类型 说明
target_instance_i
d 是 String 灾备实例的实例ID。
target_project_id 是 String 灾备实例所在租户的项目 ID。
target_region 是 String 灾备实例所在的区域 ID。
target_ip 是 String 灾备实例的数据虚拟IP（数 据VIP）。
target_subnet 是 String 灾备实例的子网地址。
● 请求样例
{ "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.0/24"
} }
响应消息
● 正常响应要素说明
表4-99 要素说明
名称 参数类型 说明
job_id String 工作流 ID。
● 正常响应样例
{ "job_id": "184f29cd-be1a-43f1-5b6bc5500e73"
}
● 异常响应
请参见异常请求结果。
状态码
● 正常 200
● 异常
请参见状态码。
错误码
请参见错误码。
4.6.2 配置灾备实例容灾能力
功能介绍
实例建立跨云或跨Region容灾关系时配置灾备实例的容灾能力。
● 调用接口前，您需要了解API 认证鉴权。
调试
您可以在API Explorer中调试该接口。
接口约束
● 主实例配置容灾能力成功后才能配置灾备实例容灾能力，否则容灾关系会建立失 败。
● 主实例和灾备实例状态正常，主实例和灾备实例在不同云或不同Region且灾备实 例为单实例。
● 灾备实例的规格要保持大于等于主实例。
● 仅PostgreSQL 12支持建立跨云或跨Region容灾关系，且功能正在公测。
● 不支持跨大版本建立跨云或跨Region容灾关系。
URI
● URI格式
POST /v3/{project_id}/instances/{instance_id}/action
● URI样例
https://rds.cn-north-1.myhuaweicloud.com/
v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in03/
action
● 参数说明
表4-100 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID。
请求消息
● 参数说明
表4-101 参数说明
名称 是否必选 参数类型 说明
build_slave_dr_re
lation 是 Object 配置容灾实例灾备关系所需
要的主实例信息。
详情请参见表4-102。
表4-102 build_slave_dr_relation 字段数据结构说明
名称 是否必选 参数类型 说明
target_instance_i
d 是 String 主实例的实例 ID。
target_project_id 是 String 主实例所在租户的项目 ID。
target_region 是 String 主实例所在的区域 ID。
target_ip 是 String 主实例的数据虚拟IP（数据 VIP）。
● 请求样例
{ "build_slave_dr_relation": {
"target_instance_id":"c39bd176fb0540929f6add80b91b212cin03", "target_project_id":"054b61972980d4552f0bc00ac8d3f5cd", "target_region":"aaa",
"target_ip":"192.168.3.238"
} }
响应消息
● 正常响应要素说明
表4-103 要素说明
名称 参数类型 说明
job_id String 工作流 ID。
● 正常响应样例
{ "job_id": "184f29cd-be1a-43f1-5b6bc5500e73"
}
● 异常响应
请参见异常请求结果。
状态码
● 正常 200
● 异常
请参见状态码。
错误码
请参见错误码。
4.6.3 灾备实例升主
功能介绍
实例间建立的跨云或跨Region容灾关系出现异常后，将灾备实例升级为主实例。
● 调用接口前，您需要了解API 认证鉴权。
调试
您可以在API Explorer中调试该接口。
接口约束
● 主实例和灾备实例状态正常，主实例和灾备实例在不同云或不同Region且灾备实 例为单实例。
● 主实例和灾备实例的容灾关系建立完成。
● 仅PostgreSQL 12支持灾备实例升级为主实例，且功能正在公测。
URI
● URI格式
POST /v3/{project_id}/instances/{instance_id}/action
● URI样例
https://rds.cn-north-1.myhuaweicloud.com/
v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/
action
● 参数说明
表4-104 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID。
请求消息
● 参数说明
表4-105 参数说明
名称 是否必选 参数类型 说明
drreplica_to_mas
ter 是 Object 灾备实例升级为主实例的标
识符，无其他参数。
● 请求样例
{ "drreplica_to_master": {}
}
响应消息
● 正常响应要素说明
表4-106 要素说明
名称 参数类型 说明
job_id String 任务ID。
● 正常响应样例
{ "job_id": "04efe8e2-9255-44ae-a98b-d87cae411890"
}
● 异常响应
请参见异常请求结果。
状态码
● 正常 200
● 异常
请参见状态码。
错误码
请参见错误码。
4.6.4 查询容灾复制状态
功能介绍
建立跨云或跨Region容灾关系后，查询主实例和灾备实例间的复制状态及延迟。
● 调用接口前，您需要了解API 认证鉴权。
调试
您可以在API Explorer中调试该接口。
接口约束
● 主实例和灾备实例的容灾关系已建立完成。
● 仅PostgreSQL 12的灾备实例支持查询容灾复制状态，且功能正在公测。
URI
● URI格式
GET /v3/{project_id}/instances/{instance_id}/disaster-recovery
● URI样例
https://rds.cn-north-1.myhuaweicloud.com/
v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/
disaster-recovery
● 参数说明
表4-107 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID。
请求消息
● 参数说明 无。
● 请求样例 无。
响应消息
● 正常响应要素说明
表4-108 要素说明
名称 参数类型 说明
replica_state String 同步状态，取值范围是0或-1，0表示正常，-1 表示异常。
wal_write_receive
_delay_in_mb String 发送延迟大小（MB），即主实例当前wal日志 写入位点与灾备实例当前接收wal日志位点的 差值。
wal_write_replay_
delay_in_mb String 端到端延迟大小（MB），即主实例当前wal日 志写入位点与灾备实例当前回放wal日志位点 的差值。
wal_receive_repla
y_delay_in_ms String 回放延迟时间（ms），即数据在灾备上回放的 延迟时间。
● 正常响应样例
{ "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"
}
● 异常响应
请参见异常请求结果。
状态码
● 正常 200
● 异常
请参见状态码。
错误码
请参见错误码。