恢复到新实例

project_id

是

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

name

是

String

参数解释：

实例名称。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

availability_zone

是

String

参数解释：

可用区ID。

约束限制：

不涉及。

取值范围：

非空，可选部署在同一可用区或三个不同可用区，可用区之间用逗号隔开。详见示例。

• 部署在同一可用区：需要输入三个相同的可用区。
• 部署在三个不同可用区：需要分别输入三个不同的可用区。

取值范围：非空，请参见地区和终端节点。

默认取值：

不涉及。

flavor_ref

是

String

参数解释：

规格码。

取值范围：

非空。参考查询数据库规格中“spec_code”字段获取。

默认取值：

不涉及。

volume

是

Object

参数解释：

volume信息。

详情请参见表3。

约束限制：

不涉及。

disk_encryption_id

否

String

参数解释：

用于磁盘加密的密钥ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

默认为空。

vpc_id

是

String

参数解释：

虚拟私有云ID，获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。
• 方法2：获取方法请参见《虚拟私有云API参考》中“查询VPC列表”的内容。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

subnet_id

是

String

参数解释：

子网的网络ID信息，获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。
• 方法2：获取方法请参见《虚拟私有云API参考》中“查询子网列表”的内容。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

security_group_id

是

String

参数解释：

指定实例所属的安全组。

• 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。
• 方法2：获取方法请参见《虚拟私有云API参考》中“查询安全组列表”的内容。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

password

是

String

参数解释：

数据库密码。

约束限制：

不涉及。

取值范围：

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

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

默认取值：

不涉及。

charge_info

否

Object

参数解释：

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

详情请参见表4。

约束限制：

不涉及。

backup_strategy

否

Object

参数解释：

自动备份策略。

详情请参见表6。

约束限制：

不涉及。

restore_point

是

Object

参数解释：

恢复数据源对象。

详情请参见表5。

约束限制：

不涉及。

enable_parallel_restore

否

Boolean

参数解释：

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

约束限制：

不涉及。

取值范围：

• true：支持备份并行恢复。
• false：不支持备份并行恢复。

默认取值：

不涉及。

configuration_id

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enterprise_project_id

否

String

参数解释：

企业项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

port

否

String

参数解释：

数据库对外开放端口。

约束限制：

限制端口： 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。

取值范围：

1024-39998。

默认取值：

8000

time_zone

否

String

参数解释：

UTC时区。

约束限制：

不涉及。

取值范围：

• 不选择时，GaussDB国际站默认为UTC时间。

• 选择填写时，取值范围为UTC-12:00~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。

默认取值：

GaussDB国际站默认为UTC时间。

enable_force_switch

否

Boolean

参数解释：

是否开启备机强升主功能。

约束限制：

仅支持1.2.2及以上版本。

取值范围：

• true：表示开启备机强升主功能。
• false：表示关闭备机强升主功能。

默认取值：

false

type

是

String

参数解释：

磁盘类型。

约束限制：

不涉及。

取值范围：

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

支持ULTRAHIGH，表示本地盘；支持ESSD，表示极速云盘。

默认取值：

不涉及。

size

是

Integer

参数解释：

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

约束限制：

需要大于等于原实例。

取值范围：

ECS部署方案：（分片数*40GB）~（分片数*16TB），且大小只能为分片数*4GB的整数倍。

默认取值：

不涉及。

charge_mode

是

String

数解释：

计费模式。

约束限制：

不涉及。

取值范围：

• postPaid：后付费，即按需付费。
• prePaid：预付费，即包年/包月。

默认取值：

不涉及。

period_type

否

string

参数解释：

订购周期类型。

约束限制：

“charge_mode”为“prePaid”时生效，且为必选值。

取值范围：

• month：包月。
• year：包年。

默认取值：

不涉及。

period_num

否

integer

参数解释：

订购的时间。

约束限制：

“charge_mode”为“prePaid”时生效，且为必选值。

取值范围：

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

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

默认取值：

不涉及。

is_auto_renew

否

boolean

参数解释：

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

约束限制：

不涉及。

取值范围：

• true，为自动续订。
• false，为不自动续订。

默认取值：

false

is_auto_pay

否

boolean

参数解释：

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

约束限制：

不涉及。

取值范围：

• true，为自动支付。
• false，为手动支付。

默认取值：

false

instance_id

是

String

参数解释：

源实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

backup_id

否

String

参数解释：

用于恢复的备份ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

否

String

参数解释：

恢复方式。

约束限制：

不涉及。

取值范围：

• “backup”，表示使用备份文件恢复，按照此方式恢复时，“type”字段为非必选，“backup_id”必选。
• “timestamp”，表示按时间点恢复，按照此方式恢复时，“type”字段必选，“restore_time”必选。

默认取值：

不涉及。

restore_time

否

Long

参数解释：

恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

start_time

是

String

参数解释：

废弃字段，无需填写。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

keep_days

否

Integer

参数解释：

废弃字段，无需填写。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance

Object

参数解释：

实例信息。

详情请参见表8。

job_id

String

参数解释：

恢复新实例的任务ID。

取值范围：

不涉及。

order_id

string

参数解释：

创建实例的订单ID。

仅创建包周期实例时会返回该参数。

取值范围：

不涉及。

id

String

参数解释：

实例ID。

取值范围：

不涉及。

name

String

参数解释：

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

取值范围：

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

status

String

参数解释：

实例状态。如BUILD，表示创建中。

取值范围：

不涉及。

datastore

Object

参数解释：

数据库信息。

详情请参见表9

ha

Object

参数解释：

实例部署形态。

详情请参见表10

port

String

参数解释：

数据库端口信息。

取值范围：

1024-39998。

限制端口： 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。

enterprise_project_id

String

参数解释：

项目标签。

取值范围：

不涉及。

volume

Object

参数解释：

volume信息。

详情请参见表11

backup_strategy

Object

参数解释：

自动备份策略。

详情请参见表12

replica_num

Integer

参数解释：

实例副本数。

取值范围：

不涉及。

region

String

参数解释：

区域ID。

取值范围：

非空，请参见地区和终端节点。

flavor_ref

String

参数解释：

规格码。

取值范围：

不涉及。

availability_zone

String

参数解释：

可用区ID。可选部署在同一可用区或三个不同可用区，可用区之间用逗号隔开。

非空，请参见地区和终端节点。

vpc_id

String

参数解释：

虚拟私有云ID。

取值范围：

不涉及。

subnet_id

String

参数解释：

子网ID。

取值范围：

不涉及。

security_group_id

String

参数解释：

安全组ID。

取值范围：

不涉及。

charge_info

Object

参数解释：

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

详情请参见表13。

type

String

参数解释：

数据库引擎。

取值范围：

GaussDB

version

String

参数解释：

数据库版本。

取值范围：

不涉及。

mode

String

参数解释：

模式。

取值范围：

GaussDB 分布式模式，返回值为：enterprise（企业版）；集中式版，返回值为：centralization_standard(集中式版)。

replication_mode

String

参数解释：

备机同步模式。

取值范围：

固定取值为sync，表示数据同步方式为“同步模式”。

consistency

String

参数解释：

GaussDB的预留参数，指定实例一致性类型。

取值范围：

• strong（强一致性）
• eventual(最终一致性)

type

String

参数解释：

磁盘类型。

取值范围：

区分大小写：

• ULTRAHIGH，表示SSD。
• ESSD，表示极速云盘

size

Integer

参数解释：

磁盘大小。

取值范围：

GaussDB分布式实例恢复时需指定大小：要求必须为（分片数*4GB）的倍数，取值范围：（分片数*40GB）~（分片数*16TB）。

start_time

String

参数解释：

废弃字段。无需关注。

取值范围：

不涉及。

keep_days

Integer

参数解释：

废弃字段。无需关注。

取值范围：

不涉及。

charge_mode

String

参数解释：

计费模式。

取值范围：

• postPaid：后付费，即按需付费。
• prePaid：预付费，即包年/包月。

period_type

string

参数解释：

订购周期类型。“charge_mode”为“prePaid”时生效。

取值范围：

• month：包月。
• year：包年。

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，表示手动从账户中支付默认为该支付方式。