文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 容灾管理/ 灾备实例容灾升主
更新时间：2025-08-11 GMT+08:00
查看PDF
分享

灾备实例容灾升主

功能介绍

容灾升主（failover），灾备实例端下发。

约束限制

支持在灾备Region下发。

URI

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/failover

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

is_support_restore

否

Boolean

参数解释：

是否支持容灾回切，默认值是false。

约束限制：

仅支持数据库版本大于等于V2.0-3.200，容灾类型为流式容灾。

取值范围：

  • true：支持。
  • false：不支持，默认false。

默认取值：

false

disaster_type

是

String

参数解释：

容灾类型。

约束限制：

不涉及。

取值范围：

  • stream：流式容灾。

默认取值：

不涉及。

响应参数

表3 响应Body参数列表

名称

参数类型

说明

job_id

String

参数解释：

任务ID。

取值范围：

不涉及。

请求示例

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/failover
{
  "is_support_restore": true,
  "disaster_type": "stream"
}

响应示例

{ 
    "job_id":"8bf0175e-562e-45f6-942a-2e2c72c577d7" 
}

状态码

错误码

请参见错误码。

父主题： 容灾管理