创建数据库实例 - CreateGaussMySqlInstance

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

• en-us

• zh-cn

默认取值：

en-us。

region

是

String

参数解释：

区域ID。

约束限制：

不涉及。

取值范围：

请参考地区和终端节点。

默认取值：

不涉及。

name

是

String

参数解释：

实例名称。

约束限制：

同一租户下，同类型的实例名可重名。

取值范围：

最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。

默认取值：

不涉及。

datastore

是

MysqlDatastoreInReq object

参数解释：

数据库信息。

约束限制：

不涉及。

mode

是

String

参数解释：

实例模式。

约束限制：

目前仅支持Cluster。

取值范围：

Cluster：集群版。

默认取值：

不涉及。

flavor_ref

是

String

参数解释：

规格码。

使用可参考查询数据库规格 - ShowGaussMySqlFlavors响应消息表5中的“spec_code”

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

vpc_id

是

String

参数解释：

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

• 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。

• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

subnet_id

是

String

参数解释：

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

• 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。

• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

password

是

String

参数解释：

数据库密码。

约束限制：

建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您输入弱密码，系统会自动判定密码非法。

取值范围：

至少包含以下字符的三种：大小写字母、数字和特殊符号|.~!@#$%^*-_=+?,()&，长度8~32个字符。

默认取值：

不涉及。

availability_zone_mode

是

String

参数解释：

可用区类型。

约束限制：

不涉及。

取值范围：

• single：单可用区。

• multi：多可用区。

默认取值：

不涉及。

slave_count

是

Integer

参数解释：

只读节点个数。

约束限制：

单次接口调用最多支持创建9个只读节点。

取值范围：

1-9。

默认取值：

不涉及。

charge_info

是

MysqlChargeInfo object

参数解释：

计费类型信息，支持包年包月和按需计费，默认为按需计费。

约束限制：

DeC专属云账号不支持创建包年/包月实例。

security_group_id

否

String

参数解释：

安全组ID。获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。

• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。

约束限制：

如果实例所选用的子网开启网络ACL进行访问控制，则该参数非必选。如果未开启ACL进行访问控制，则该参数必选。

取值范围：

不涉及。

默认取值：

不涉及。

configuration_id

否

String

参数解释：

参数模板ID。使用可参考查询参数模板 - ListGaussMySqlConfigurations中响应消息表5的“id”。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

backup_strategy

是

MysqlBackupStrategy object

参数解释：

自动备份策略。

约束限制：

不涉及。

time_zone

否

String

参数解释：

时区信息。

约束限制：

不涉及。

取值范围：

UTC-11:00~+12:00内的所有整点时间。

默认取值：

UTC。

master_availability_zone

否

String

参数解释：

主可用区ID。

约束限制：

创建单可用区实例选填，多可用区实例必填。

取值范围：

请参考地区和终端节点。

默认取值：

不涉及。

volume

否

MysqlVolume object

参数解释：

volume信息。

约束限制：

创建包年/包月实例可选。创建按需实例时不可选。

tags

否

Array of MysqlTags objects

参数解释：

标签列表，根据标签键值对创建实例。

约束限制：

• {key}表示标签键，不可以为空或重复。

• {value}表示标签值，可以为空。

如果创建实例时同时使用多个标签键值对，中间使用逗号分隔开，最多包含20组。

lower_case_table_names

否

Integer

参数解释：

表名大小写是否敏感。

约束限制：

创建完成后不支持修改。

取值范围：

• 0：表名被存储成固定且表名称大小写敏感。

• 1：表名将被存储成小写且表名称大小写不敏感。

默认取值：

1。

enterprise_project_id

否

String

参数解释：

企业项目ID。

约束限制：

如果账户开通企业项目服务则该参数必选，未开启该参数不可选。

取值范围：

不涉及。

默认取值：

不涉及。

dedicated_resource_id

否

String

参数解释：

专属资源池ID。

约束限制：

只有开通专属资源池后才支持此参数。

取值范围：

不涉及。

默认取值：

不涉及。

restore_point

否

MysqlRestorePoint object

参数解释：

备份恢复信息。

约束限制：

不涉及。

tde_info

否

MysqlTdeInfo object

参数解释：

透明数据加密配置信息，支持AES256、SM4加密算法。

约束限制：

透明加密功能目前处于公测阶段，如需使用，请提交工单联系客服人员申请权限。

type

是

String

参数解释：

数据库引擎名称。

约束限制：

现在只支持gaussdb-mysql。

取值范围：

gaussdb-mysql。

默认取值：

不涉及。

version

是

String

参数解释：

数据库版本。

约束限制：

不涉及。

取值范围：

两位数的大版本号，获取方法请参见查询数据库引擎的版本- ShowGaussMySqlEngineVersion返回的name字段。

默认取值：

不涉及。

kernel_version

否

String

参数解释：

内核数据库版本。如果需要指定具体的内核版本，请联系客服人员添加白名单。

约束限制：

不涉及。

取值范围

完整的四位内核数据库版本，获取方法请参见查询数据库引擎的版本- ShowGaussMySqlEngineVersion返回的kernel_version字段。

默认取值：

不涉及。

charge_mode

是

String

参数解释：

计费模式。

约束限制：

不涉及。

取值范围：

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

默认取值：

postPaid。

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

否

String

参数解释：

创建包年/包月实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

约束限制：

charge_mode为prePaid时生效。

取值范围：

• true：自动续订。

• false：不自动续订。

默认取值：

false。

is_auto_pay

否

String

参数解释：

创建包年/包月实例时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。

约束限制：

charge_mode为prePaid时生效。

取值范围：

• true：自动支付。

• false：手动支付。

默认取值：

true。

start_time

是

String

参数解释：

自动备份开始时间段。自动备份将在该时间一个小时内触发。

约束限制：

不涉及。

取值范围：

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

1. HH取值必须比hh大1。

2. mm和MM取值必须相同，且取值必须为00。

默认取值：

不涉及。

keep_days

否

String

参数解释：

自动备份保留天数。

约束限制：

值为正整数。

取值范围：

1-732。

默认取值：

不涉及。

size

是

String

参数解释：

磁盘大小，单位GB。

约束限制：

必须为10的整数倍。

取值范围：

10~128000。

默认取值：

10。

key

是

String

参数解释:

标签键。

约束限制：

key不能为空或者空字符串，不能为空格。

取值范围：

最大长度36个unicode字符。字符集：A-Z，a-z ，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

默认取值：

不涉及。

value

是

String

参数解释:

标签值。

约束限制：

可以为空字符串。

取值范围：

最大长度43个unicode字符。字符集：A-Z，a-z ，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

默认取值：

不涉及。

source_instance_id

是

String

参数解释：

源实例ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。

restore_time

否

Long

参数解释：

需要恢复的备份时间点。

约束限制：

格式为UNIX时间戳，单位是毫秒，时区为UTC标准时区。传参时需要将对应时区的时间转为标准时区对应的时间戳。

取值范围：

通过查询可恢复时间段 - ShowBackupRestoreTime获取。

默认取值：

不涉及。

backup_id

否

String

参数解释：

备份文件ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

否

String

参数解释：

备份类型。

约束限制：

当参数为空时，backup_id不能为空，即默认按备份文件恢复

取值范围：

当参数不为空时，取值范围：

• backup：表示按备份文件恢复。

• timestamp：表示按时间点恢复。

默认取值：

不涉及。

enable_tde

是

Boolean

参数解释：

是否打开透明加密功能。

约束限制：

不涉及。

取值范围：

• true: 打开。

• false: 关闭。

默认取值：

不涉及。

encryption_type

是

String

参数解释:

透明加密算法。

约束限制：

不涉及。

取值范围：

• AES256。

• SM4。

默认取值：

不涉及。

instance

MysqlInstanceResponse object

参数解释：

实例信息。

job_id

String

参数解释

实例创建的任务ID。

仅创建按需实例时会返回该参数。

取值范围：

不涉及。

order_id

String

参数解释：

订单号，创建包年包月时返回该参数。

取值范围：

不涉及。

id

String

参数解释：

实例ID。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

name

String

参数解释：

实例名称。

取值范围：

与请求参数中的实例名称一致。

status

String

参数解释：

实例状态。

取值范围：

BUILD：实例创建中。

datastore

MysqlDatastore object

参数解释：

数据库信息。

mode

String

参数解释：

实例模式。

取值范围：

与请求参数中的实例模式一致。

configuration_id

String

参数解释：

参数组ID。

取值范围：

不涉及。

port

String

参数解释：

数据库端口信息。

取值范围：

不涉及。

backup_strategy

MysqlBackupStrategy object

参数解释：

自动备份策略。

约束限制：

不涉及。

enterprise_project_id

String

参数解释：

企业项目ID。

取值范围：

和请求参数中的企业项目ID保持一致。

region

String

参数解释：

区域ID。

取值范围：

与请求参数中的区域ID一致。

availability_zone_mode

String

参数解释：

可用区模式。

取值范围：

与请求参数中的可用区模式一致。

master_availability_zone

String

参数解释：

主可用区ID。

取值范围：

与请求参数中的主可用区ID一致。

vpc_id

String

参数解释：

虚拟私有云ID，与请求参数相同。

取值范围：

与请求参数中的虚拟私有云ID一致。

security_group_id

String

参数解释：

安全组ID，与请求参数相同。

取值范围：

与请求参数中的安全组ID一致。

subnet_id

String

参数解释：

子网ID，与请求参数相同。

取值范围：

与请求参数中的子网ID一致。

flavor_ref

String

参数解释：

规格码。

取值范围：

与请求参数中的规格码一致。

charge_info

MysqlChargeInfo object

参数解释：

计费类型信息，支持包年/包月和按需计费，默认为按需计费。

volume

MysqlVolumeResp object

参数解释：

volume信息。创建包年/包月实例有返回。

type

String

参数解释：

数据库引擎。

取值范围：

gaussdb-mysql。

version

String

参数解释：

数据库版本。

取值范围：

不涉及。

kernel_version

String

参数解释：

内核数据库版本。

取值范围：

不涉及。

start_time

String

参数解释：

自动备份开始时间段。自动备份将在该时间一个小时内触发。

约束限制：

不涉及。

取值范围：

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

1. HH取值必须比hh大1。

2. mm和MM取值必须相同，且取值必须为00。

默认取值：

不涉及。

keep_days

String

参数解释：

自动备份保留天数。

约束限制：

值为正整数。

取值范围：

1-732。

默认取值：

不涉及。

charge_mode

String

参数解释：

计费模式。

约束限制：

不涉及。

取值范围：

• prePaid：预付费，即包年/包月。

• postPaid：后付费，即按需付费。

默认取值：

postPaid。

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

String

参数解释：

创建包年/包月实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

约束限制：

charge_mode为prePaid时生效。

取值范围：

• true：自动续订。

• false：不自动续订。

默认取值：

false。

is_auto_pay

String

参数解释：

创建包年/包月实例时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。

约束限制：

charge_mode为prePaid时生效。

取值范围：

• true：自动支付。

• false：手动支付。

默认取值：

true。

size

Integer

参数解释

磁盘大小, 单位GB。

取值范围：

10~128000，为10的整数倍。

error_code

String

错误码。

error_msg

String

错误消息。

error_code

String

错误码。

error_msg

String

错误消息。