云数据库 TaurusDB-创建数据库实例:请求参数

时间：2025-02-12 14:58:09

云数据库 TaurusDB

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用 IAM 服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
X-Language	否	String	请求语言类型。默认en-us。取值范围： en-us zh-cn

表3 请求Body参数
参数	是否必选	参数类型	描述
region	是	String	区域ID。
name	是	String	实例名称。用于表示实例的名称，同一租户下，同类型的实例名可重名。取值范围：最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。
datastore	是	MysqlDatastoreInReq object	数据库信息。
mode	是	String	实例类型，目前仅支持Cluster。
flavor_ref	是	String	规格码。使用可参考查询数据库规格响应消息表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个只读节点。
charge_info	是	MysqlChargeInfo object	计费类型信息，支持包年包月和按需，默认为按需。说明：DeC专属云账号不支持创建包年/包月实例。
security_group_id	否	String	安全组ID。如果实例所选用的子网开启网络ACL进行访问控制，则该参数非必选。如果未开启ACL进行访问控制，则该参数必选。获取方法如下：方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。
configuration_id	否	String	参数模板ID。使用可参考查询参数模板中响应消息表5的“id”。
backup_strategy	是	MysqlBackupStrategy object	自动备份策略。
time_zone	否	String	时区。默认时区为UTC。
master_availability_zone	否	String	主可用区ID，创建单可用区实例选填，多可用区实例必填，请参考地区和终端节点。
volume	否	MysqlVolume object	volume信息。创建包年/包月实例可选。创建按需实例时不可选。
tags	否	Array of MysqlTags objects	标签列表，根据标签键值对创建实例。 {key}表示标签键，不可以为空或重复。 {value}表示标签值，可以为空。如果创建实例时同时使用多个标签键值对，中间使用逗号分隔开，最多包含10组。
lower_case_table_names	否	Integer	表名大小写是否敏感，默认值是1。取值范围： 0：表名被存储成固定且表名称大小写敏感。 1：表名将被存储成小写且表名称大小写不敏感。
enterprise_project_id	否	String	企业项目ID。如果账户开通企业项目服务则该参数必选，未开启该参数不可选。
dedicated_resource_id	否	String	专属资源池ID，只有开通专属资源池后才支持此参数。
restore_point	否	MysqlRestorePoint object	备份恢复信息。
tde_info	否	MysqlTdeInfo object	透明数据加密配置信息，支持AES256、SM4加密算法。透明加密功能目前处于公测阶段，如需使用，请提交工单联系客服人员申请权限。

表4 MysqlDatastoreInReq
参数	是否必选	参数类型	描述
type	是	String	数据库引擎，现在只支持gaussdb-mysql。
version	是	String	数据库版本。两位数的大版本号，获取方法请参见查询数据库引擎的版本返回的name字段。
kernel_version	否	String	内核数据库版本。如果需要指定具体的内核版本，请联系客服人员添加白名单。完整的四位内核数据库版本，获取方法请参见查询数据库引擎的版本返回的kernel_version字段。

表5 MysqlChargeInfo
参数	是否必选	参数类型	描述
charge_mode	是	String	计费模式。取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。
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	否	String	创建包年/包月实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true：为自动续订。 false：为不自动续订，默认该方式。
is_auto_pay	否	String	创建包年/包月实例时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true：为自动支付，默认该方式。 false：为手动支付。

表6 MysqlBackupStrategy
参数	是否必选	参数类型	描述
start_time	是	String	自动备份开始时间段。自动备份将在该时间一个小时内触发。取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。
keep_days	否	String	自动备份保留天数，取值范围：1-732。

表7 MysqlVolume
参数	是否必选	参数类型	描述
size	是	String	磁盘大小。默认值为10，单位GB。取值范围：10~128000，必须为10的整数倍。

表8 MysqlTags
参数	是否必选	参数类型	描述
key	是	String	标签键。最大长度36个unicode字符。key不能为空或者空字符串，不能为空格。字符集：A-Z，a-z ，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。
value	是	String	标签值。最大长度43个unicode字符。可以为空字符串。字符集：A-Z，a-z ，0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

表9 MysqlRestorePoint
参数	是否必选	参数类型	描述
source_instance_id	是	String	源实例ID。
restore_time	否	Long	需要恢复的时间点。（Point-In-Time Recovery, PITR）。
backup_id	否	String	备份文件ID。
type	否	String	备份类型。当参数为空时，backup_id不能为空，即默认按备份文件恢复。当参数不为空时，取值范围： backup：表示按备份文件恢复。 timestamp：表示按时间点恢复。