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

时间：2023-11-01 16:20:15

云数据库 GaussDB

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。
X-Language	否	String	语言。

表3 请求Body参数
参数	是否必选	参数类型	描述
charge_info	否	MysqlChargeInfo object	计费类型信息，支持包年包月和按需，默认为按需。说明：DeC专属云账号不支持创建包周期。
region	是	String	区域ID。
name	是	String	实例名称。用于表示实例的名称，同一租户下，同类型的实例名可重名。取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。
datastore	是	MysqlDatastore object	数据库信息。
mode	是	String	实例类型，目前仅支持Cluster。
flavor_ref	是	String	规格码。
vpc_id	是	String	虚拟私有云ID。
subnet_id	是	String	子网的网络ID。
security_group_id	否	String	安全组ID。如果实例所选用的子网开启网络ACL进行访问控制，则该参数非必选。如果未开启ACL进行访问控制，则该参数必选。
configuration_id	否	String	参数模板ID。
password	是	String	数据库密码。取值范围：至少包含以下字符的三种：大小写字母、数字和特殊符号~!@#$%^*-_=+?,()&，长度8~32个字符。建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您输入弱密码，系统会自动判定密码非法。
backup_strategy	否	MysqlBackupStrategy object	自动备份策略
time_zone	否	String	时区。
availability_zone_mode	是	String	可用区类型,单可用区Single或多可用区multi。
master_availability_zone	否	String	主可用区。
slave_count	是	Integer	备节点个数。单次接口调用最多支持创建9个备节点。
volume	否	MysqlVolume object	volume信息。创建包周期实例可选。
tags	否	Array of MysqlTags objects	标签列表，根据标签键值对创建实例。 {key}表示标签键，不可以为空或重复。 {value}表示标签值，可以为空。如果创建实例时同时使用多个标签键值对，中间使用逗号分隔开，最多包含10组。
enterprise_project_id	否	String	企业项目ID。如果账户开通企业项目服务则该参数必选，未开启该参数不可选。
dedicated_resource_id	否	String	专属资源池ID，只有开通专属资源池后才可以下发此参数。

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

表5 MysqlDatastore
参数	是否必选	参数类型	描述
type	是	String	数据库引擎，现在只支持gaussdb-mysql
version	是	String	数据库版本。数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。

表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	磁盘大小。默认值为40，单位GB。取值范围：40~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）。