云数据库 GaussDB-恢复到新实例:请求消息

时间:2023-11-01 16:19:35

请求消息

表2 参数说明

参数

是否必选

参数类型

描述

name

String

实例名称。

用于表示实例的名称,同一租户下,同类型的实例名可重名。

取值范围:4~64个字符之间,必须以字母开头,区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。

availability_zone

String

可用区ID。

GaussDB取值范围:非空,可选部署在同一可用区或三个不同可用区,可用区之间用逗号隔开。详见示例。

  • 部署在同一可用区:需要输入三个相同的可用区。例如:部署在“cn-north-4a”可用区,则需要在此处输入"cn-north-4a,cn-north-4a,cn-north-4a"。
  • 部署在三个不同可用区:需要分别输入三个不同的可用区。

取值范围:非空,请参见地区和终端节点

flavor_ref

String

规格码,取值范围:非空。参考数据库实例规格GaussDB的“规格编码”列内容获取。

volume

Object

volume信息。

详情请参见表3

disk_encryption_id

String

用于磁盘加密的密钥ID,默认为空。

vpc_id

String

虚拟私有云ID,获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。
  • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询VPC列表

subnet_id

String

子网的网络ID信息,获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。
  • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表

security_group_id

String

指定实例所属的安全组。如果不需要指定安全组,请联系客服申请白名单。

  • 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。
  • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询安全组列表

password

String

数据库密码。

GaussDB密码取值范围:

非空; 至少包含大写字母(A-Z),小写字母(a-z),数字(0-9),非字母数字字符(限定为~!@#%^*-_=+?,)四类字符中的三类字符;长度8~32个字符。

建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。

charge_info

Object

付费方式信息,支持按需和包周期。

详情请参见表4

backup_strategy

Object

自动备份策略。

详情请参见表6

restore_point

Object

恢复数据源对象。

详情请参见表5

enable_parallel_restore

Boolean

是否支持备份并行恢复。当不传该参数时,企业版默认为不支持,主备版默认支持。

configuration_id

String

参数组ID。当不传该参数时,使用系统默认的参数模板。

enterprise_project_id

String

企业项目ID。

port

String

数据库对外开放的端口,不填默认为8000,可选范围为:1024-39998。限制端口: 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。

time_zone

String

UTC时区。

  • 不选择时,GaussDB国内站默认为UTC时间。
  • 选择填写时,取值范围为UTC-12:00~UTC+12:00,且只支持整段时间,如UTC+08:00,不支持UTC+08:30。

enable_force_switch

Boolean

enable_force_switch表示是否开启备机强升主功能,仅支持取值true,false。

enable_force_switch=true表示开启备机强升主功能,enable_force_switch=false表示关闭,默认关闭。仅支持1.2.2及以上版本。

说明:

备机强升主功能适用场景:在主机发生故障后,为了保障集群的可用性,强制拉起备机作为新主机对外提供服务的场景。 本功能在集群故障状态下,以丢失部分数据为代价换取集群尽可能快的恢复服务。本功能是集群状态为不可用时的一个逃生方法,如果操作者不清楚备机强升后丢失数据对业务的影响,请勿使用本功能。

表3 volume字段数据结构说明

参数

是否必选

参数类型

描述

type

String

磁盘类型。

主备模式仅支持LOCALSSD,分布式模式独立部署仅支持ULTRAHIGH,区分大小写,表示本地SSD盘及云磁盘。

支持ULTRAHIGH,表示本地盘;支持ESSD,表示极速云盘。

size

Integer

磁盘大小,需要大于等于原实例。例如:该参数填写为“40”,表示为恢复的实例分配40GB的磁盘空间。

ECS部署方案取值范围:(分片数*40GB)~(分片数*16TB),且大小只能为分片数*40的整数倍。

表4 charge_info字段数据结构说明

参数

是否必选

参数类型

描述

charge_mode

String

计费模式。支持postPaid,后付费,即按需付费;perPaid,先付费,即包周期。

period_type

string

订购周期类型。month:包月。year:包年。 说明: “charge_mode”为“prePaid”时生效,且为必选值。

period_num

integer

“charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。

取值范围:

当“period_type”为“month”时,取值为1~9。 当“period_type”为“year”时,取值为1~3。

当传入浮点型时,会自动截取为整型。

is_auto_renew

boolean

创建包周期实例时可指定,表示是否自动续订,续订时会自动支付。 按月订购时续订周期默认为1个月,按年订购时续订周期默认为1年,续订周期可自定义修改。

true,表示自动续订。 false,表示不自动续订,默认为该方式。

is_auto_pay

boolean

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

true,表示自动从账户中支付。 false,表示手动从账户中支付,默认为该支付方式。

表5 restore_point字段数据结构说明

参数

是否必选

参数类型

描述

instance_id

String

源实例ID。

backup_id

String

用于恢复的备份ID。

表6 backup_strategy字段数据结构说明

参数

是否必选

参数类型

描述

start_time

String

废弃字段,无需填写。

keep_days

Integer

废弃字段,无需填写。

support.huaweicloud.com/api-opengauss/opengauss_newapi_0027.html