调用 CreateDBInstance 接口创建新实例。

请求类型

异步请求。

注意事项

自 2022 年 05 月 17 日起，新开通 veDB MySQL 产品的客户和存量实例都需要进行跨服务访问授权。跨服务访问授权方法如下：

通过 veDB MySQL 控制台授权。详细操作，请参见跨服务访问授权。

调用 CreateServiceLinkedRole（ServiceName 为 vedbm）接口完成跨服务授权。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceName	String	否	test	实例名称。命名规则：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需在 1~128 个字符内。说明如果未填写实例名称，则会使用实例 ID 作为实例名称。批量创建实例时，如果传入了实例名称，则会自动在实例名称后加序号。
DBEngineVersion	String	是	MySQL_8_0	实例兼容版本。取值范围： MySQL_8_0：表示兼容社区 MySQL 8.0 版本。 MySQL_5_7：表示兼容社区 MySQL 5.7 版本。说明不同版本实例所支持的功能差异，请参见功能概览。 MySQL 5.7 目前为白名单功能，如需使用，请提交工单联系技术支持。
DBMinorVersion	String	否	3.0	根据兼容版本，选择 veDB MySQL 小版本，关于版本号的详细说明请参见版本号管理。当 DBEngineVersion 取值为 MySQL_5_7 时，该参数取值默认为 2.0。当 DBEngineVersion 取值为 MySQL_8_0 时，该参数取值范围如下： 3.0（默认）：veDB MySQL 稳定版，100% 兼容 MySQL 8.0。 3.2：内置冷数据归档能力，可将低频访问的数据归档至对象存储 TOS 中，降低存储成本，详情请参见冷热分离介绍。说明冷热分离目前为白名单功能，如需使用，请提交工单联系技术支持。
NodeSpec	String	是	vedb.mysql.x4.xlarge	实例的节点规格代码。说明关于实例节点规格的详细信息，请参见产品规格。
ZoneIds	String	是	cn-beijing-b	可用区 ID。说明可调用 DescribeAvailabilityZones 接口查询实例支持的可用区资源。
NodeNumber	Integer	是	2	实例节点数量。取值范围为 2~16 个。
VpcId	String	是	vpc-3ajzohyfaru9s340jz1rp****	私有网络（VPC） ID。说明您可以调用 DescribeVpcs 接口查询要创建实例的 VPC ID。
SubnetId	String	是	subnet-1g15j13jtzgu88ibuxwqp****	子网 ID。子网必须属于所选的可用区。说明子网是私有网络内的 IP 地址块，私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址。您可以调用 CreateSubnet 接口创建子网，调用 DescribeSubnets 接口查询指定可用区内的所有子网列表信息，包括子网 ID。
Port	Integer	否	3306	为实例默认创建的连接终端指定私网端口号。默认取值为 3306，取值范围为 1000~65534。说明该配置项仅对主节点终端、默认终端生效。即实例创建成功后，新建的自定义终端，端口号依旧默认为 3306。实例创建成功后，您也可以随时修改端口号，操作详情请参见修改连接地址前缀和端口。
SuperAccountName	String	否	vedbuser	高权限用户的账号名称。账号名称需满足以下要求：名称唯一，且长度在 2~32 个字符内。由字母、数字、中划线（-）、下划线（_）组成。以字母开头，以字母或数字结尾。名称内不能包含某些关键词。详细信息，请参见禁用关键词。说明您可以在实例创建成功后，调用 CreateDBAccount 接口为实例创建高权限账号或普通账户。
SuperAccountPassword	String	否	kira****	高权限账号的密码。账号密码需满足以下要求：只能包含大小写字母、数字和特殊字符（如 ~!@#$%^&*_-+=`\|\(){}[]:;'<>,.?/）。长度需在 8~32 个字符内。至少包含大写字母、小写字母、数字或特殊字符中的 3 种。
DBTimeZone	String	否	UTC +08:00	实例的时区。国内所有地域默认时区为 UTC +08:00。
LowerCaseTableNames	String	否	1	表名是否区分大小写，默认取值为 1。取值范围： 0：表名称大小写敏感，后端根据实际表名存储。 1：（默认）表名称不区分大小写，后端存储时将表名称统一为小写字母。说明创建实例后不支持修改此规则，请根据业务需求合理设置。
ProjectName	String	否	default	实例所属的项目名称，当该参数留空时，新建的实例默认加入 default 项目。说明项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色管理这些资源的权限。更多详情，请参见资源管理。
Tags	Array of TagObject	否	请参见请求示例。	需要绑定的标签键和标签值数组对象。说明单次最多支持同时传入 20 组标签键值对，单个实例最多支持绑定 50 个标签。标签键值需满足设置规则，具体规则请参见标签设置规则。
DeletionProtection	String	否	disabled	开启或关闭实例删除保护功能，取值范围： enabled：开启。 disabled：关闭（默认）。说明开启后，将无法删除该实例。如需删除实例，您需要先调用 ModifyDBInstanceDeletionProtectionPolicy 接口关闭该功能。关于删除保护的更多信息，请参见实例删除保护。
StorageType	String	String	IOOptimizedStorage	存储类型。取值范围： IOOptimizedStorage：IO 性能型（默认）。 SmartCompressedStorage：智能压缩型。说明关于两种存储类型的详细介绍和价格差异，请参见存储类型对比说明。支持将存储类型从智能压缩型存储升级为 IO 性能型存储，详情请参见 ModifyDBInstanceStorageType。
ChargeType	String	是	PostPaid	计算计费类型。创建实例时计算计费类型可取值如下： PostPaid：按量计费（后付费）。 PrePaid：包年包月（预付费）。
StorageChargeType	String	否	PostPaid	存储计费类型。不传入该参数时，存储计费类型默认与计算计费类型取值一致，取值如下： PostPaid：按量计费（后付费）。 PrePaid：包年包月（预付费）。说明当计算计费类型取值为 PostPaid 时，存储计费类型也只能取值为 PostPaid。当计算计费类型取值为 PrePaid 时，存储计费类型可取值为 PrePaid 或 PostPaid。
AutoRenew	Boolean	否	false	预付费场景下是否自动续费。取值： true：自动续费。 false：不自动续费。说明当 ChargeType（计费类型）取值为 PrePaid（包年包月）时，该参数必填。
PeriodUnit	String	否	Month	预付费场景下的购买周期。 Month：包月。 Year：包年。说明当 ChargeType（计算计费类型）取值为 PrePaid（包年包月）时，该参数必填。
Period	Integer	否	1	预付费场景下的购买时长。说明当 ChargeType（计算计费类型）取值为 PrePaid（包年包月）时，该参数必填。
PrePaidStorageInGB	Integer	否	50	预付费场景下的存储空间大小。说明当 StorageChargeType（存储计费类型）取值为 PrePaid（包年包月）时，该参数必填。
Number	Integer	否	1	创建的实例数量，取值范围 1~50，默认值为 1。

TagObject

参数	类型	是否必选	示例值	描述
Key	String	是	department	实例绑定的标签键。
Value	String	否	game	实例绑定的标签值。

返回参数

参数	类型	示例值	描述
InstanceId	String	vedbm-d4mx2akm****	实例 ID。
OrderId	String	Order707643373078888****	订单 ID。

示例

请求示例 1

按量计费实例。

返回示例 1

请求示例 2

包年包月实例。

返回示例 2

错误码

更多详情，请参见错误码。

云数据库 veDB MySQL 版