文档首页/ 云数据库 GaussDB/ API参考/ API/ 实例管理/ 实例形态变更 - ChangingtheDeploymentModelofanInstance
更新时间:2026-09-24 GMT+08:00
分享

实例形态变更 - ChangingtheDeploymentModelofanInstance

功能介绍

用于变更实例的部署形态。

调试

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

接口约束

当前只支持集中式单副本变更至集中式一主两备形态或集中式一主一备一日志形态。

URI

PUT /v3/{project_id}/instances/{instance_id}/deployment/solution

表1 参数说明

名称

是否必选

参数类型

说明

project_id

是

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。请参考查询数据库实例列表 - QueryingDBInstances接口获取实例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参数

参数

是否必选

参数类型

描述

solution

是

String

参数解释:

实例变更后的目标部署形态。

约束限制:

不涉及。

取值范围:

  • logger:一主一备一日志部署形态。
  • triset:一主两备部署形态。

默认取值:

不涉及。

availability_zone

是

String

参数解释:

部署可用区,多个可用区以英文逗号","隔开。

约束限制:

不可包含 ^%&\\'`|";=?$<> 等特殊字符。

取值范围:

不涉及。

默认取值:

不涉及。

master_az

否

String

参数解释:

实例主可用区。

约束限制:

不填时默认使用当前主可用区。

取值范围:

不涉及。

默认取值:

当前实例的主可用区。

logger_az

否

String

参数解释:

日志可用区。

约束限制:

solution参数传入logger时需要传该参数。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释:

任务ID。

取值范围:

不涉及。

请求示例

集中式单副本形态切换到一主一备一日志形态。

PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/5362449138da4e408dbae5152ca26640in14/deployment/solution 
{
    "solution": "logger",
    "availability_zone": "az0.dc0,BMS_az7.dc2,BMS_az8.dc2",
    "logger_az": "BMS_az7.dc2"
}

响应示例

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

状态码

错误码

请参见错误码。

相关文档