name

是

String

参数解释：

实例名称。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

datastore

是

Object

参数解释：

数据库信息。

详情请参见表3。

约束限制：

不涉及。

ha

是

Object

参数解释：

实例部署形态。详情请参见表4。

约束限制：

不涉及。

configuration_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

password

是

String

参数解释：

数据库密码。

约束限制：

不涉及。

取值范围：

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

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

默认取值：

不涉及。

backup_strategy

否

Object

参数解释：

备份策略。

详情请参见表5。

约束限制：

不涉及。

enterprise_project_id

否

String

参数解释：

企业项目ID。

使用请参考《企业管理 API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。

约束限制：

只有企业租户时该参数才生效。

取值范围：

不涉及。

默认取值：

不涉及。

disk_encryption_id

否

String

参数解释：

用于磁盘加密的密钥ID。

密钥授权请参考《 数据加密 服务 用户指南》的“创建授权”章节。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

默认为空。

flavor_ref

是

String

参数解释：

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

约束限制：

不为空。

取值范围：

不涉及。

默认取值：

不涉及。

volume

是

Object

参数解释：

volume信息。

详情请参见表6。

约束限制：

不涉及。

region

是

String

参数解释：

区域ID。

请参见地区和终端节点。

约束限制：

不为空。

取值范围：

不涉及。

默认取值：

不涉及。

availability_zone

是

String

参数解释：

可用区ID。

约束限制：

不为空。

取值范围：

可选部署在相同可用区或不同可用区，可用区之间用逗号隔开。

调用查询数据库规格接口可在返回信息中获取到可用区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接口查询，具体操作可参考查询安全组列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

charge_info

否

Object

参数解释：

计费类型信息，仅支持按需和包周期。

详情请参见表7。

约束限制：

不涉及。

time_zone

否

String

参数解释：

UTC时区。

约束限制：

不涉及。

取值范围：

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

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

默认取值：

GaussDB国内站默认为UTC时间。

sharding_num

否

Integer

参数解释：

分片数量。

约束限制：

仅分布式形态需要填写该参数。

取值范围：

1~256。

默认取值：

不涉及。

coordinator_num

否

Integer

参数解释：

协调节点数量。

约束限制：

仅分布式形态需要填写该参数。CN数量必须小于或等于两倍的分片数。

取值范围：

1~256

默认取值：

不涉及。

replica_num

否

Integer

参数解释：

实例副本集数。

约束限制：

不涉及。

取值范围：

支持取值3。

默认取值：

3

enable_force_switch

否

Boolean

参数解释：

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

约束限制：

仅支持1.2.2及以上版本。

取值范围：

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

默认取值：

false

enable_single_float_ip

否

Boolean

参数解释：

单内网地址策略。

约束限制：

仅V2.0-3.207及以上版本的集中式版实例支持。

取值范围：

• true：开启单浮动IP策略，实例将只有一个浮动IP绑定主节点，如果发生主备倒换，浮动IP不会发生变化。
• false：不开启单浮动IP策略，每个节点都会绑定一个浮动IP，如果发生主备倒换，浮动IP会发生变化。

默认取值：

false

type

是

String

参数解释：

数据库引擎。

约束限制：

不涉及。

取值范围：

GaussDB，表示GaussDB引擎，不区分大小写。

默认取值：

GaussDB

version

否

String

参数解释：

数据库版本。

GaussDB支持的版本参考查询数据库引擎的版本查询。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

当前最新版本。

mode

是

String

参数解释：

实例模式。

约束限制：

不涉及。

取值范围：

GaussDB为分布式模式取值：enterprise(企业版) ，集中式版取值:centralization_standard，不区分大小写。

默认取值：

不涉及。

consistency

是

String

参数解释：

指定事务一致性类型。

约束限制：

不涉及。

取值范围：

不区分大小写。

• strong：强一致性。
• eventual：最终一致性。

默认取值：

不涉及。

replication_mode

是

String

参数解释：

备机同步模式。

约束限制：

不涉及。

取值范围：

sync，表示同步模式。

默认取值：

sync

instance_mode

否

String

参数解释：

指定创建实例的产品类型。

约束限制：

不涉及。

取值范围：

• enterprise：创建企业版实例。
• basic：创建基础版实例。
• ecology：创建生态版实例。

默认取值：

enterprise

start_time

是

String

参数解释：

备份时间段。自动备份将在该时间段内触发。

约束限制：

不涉及。

取值范围：

非空且非负，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。

• HH取值必须比hh大1。
• mm和MM取值必须相同，且取值必须为00。

取值示例：

• 08:00-09:00
• 23:00-00:00

默认取值：

不涉及。

keep_days

否

Integer

参数解释：

指定备份文件的可保存天数。

约束限制：

不涉及。

取值范围：

1~36500。

默认取值：

该参数缺省时，默认填写为7天。

type

是

String

参数解释：

磁盘类型。

约束限制：

不涉及。

取值范围：

• 仅支持ULTRAHIGH和ESSD，区分大小写，分别表示SSD和极速云盘。

默认取值：

不涉及。

size

是

Integer

参数解释：

磁盘大小。例如：该参数填写为“40”，表示为创建的实例分配40GB的磁盘空间。

约束限制：

不涉及。

取值范围：

E CS 部署方案：（分片数*40GB）~（分片数*24TB），且大小只能为分片数*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