文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 实例管理/ 一主一备一日志切换一主两备
更新时间:2025-09-11 GMT+08:00
分享

一主一备一日志切换一主两备

功能介绍

分布式实例一主一备一日志形态切换到一主两备形态。

调试

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

接口约束

当前只支持分布式独立部署一主一备一日志切换至一主两备形态。

URI

POST /v3/{project_id}/instances/{instance_id}/switch-replica

表1 参数说明

名称

是否必选

说明

project_id

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围

  • zh-cn
  • en-us

默认取值

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

is_auto_pay

Boolean

参数解释:

创建包周期实例时可指定,表示是否自动从账户中支付,该字段不影响自动续订的支付方式。

约束限制:

不涉及。

取值范围:

true,表示自动从账户中支付。 false,表示手动从账户中支付。

默认取值

false。

响应参数

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释:

任务ID。

取值范围:

不涉及。

order_id

String

参数解释:

订单ID。

取值范围:

不涉及。

请求示例

分布式实例一主一备一日志形态切换到一主两备形态。

 
POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/5362449138da4e408dbae5152ca26640in14/switch-replica 
{ 
  "is_auto_pay" : true 
}

响应示例

{ 
  "job_id" : "0da624f7-0eec-4e2b-bfef-0685bb5591f6" 
}

状态码

错误码

请参见错误码

相关文档