文档中心

云数据库 MySQL 版

实例管理

CreateDBInstance - 创建实例

调用 CreateDBInstance 接口创建实例。

请求类型

异步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
DBEngineVersion	String	是	MySQL_8_0	兼容版本。取值： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。 MySQL 8.4：MySQL 8.4 版本。
InstanceType	String	否	DoubleNode	绿色实例的实例类型。取值： DoubleNode，双节点类型。 MultiNode，多节点类型。 SingleNode，单节点类型。说明如蓝色实例的实例类型为单节点，可为绿色实例选择单节点或双节点的实例类型。如蓝色实例的实例类型为双节点，可为绿色实例选择双节点或多节点的实例类型。如蓝色实例的实例类型为多节点，只能为绿色实例选择多节点的实例类型。
NodeInfo	Array of NodeInfoObject	是	[ { "NodeType": "Primary", "ZoneId": "cn-beijing-a", "NodeSpec": "rds.mysql.1c2g" }, { "NodeType": "Secondary", "ZoneId": "cn-beijing-a", "NodeSpec": "rds.mysql.1c2g" }, { "NodeType": "ReadOnly", "ZoneId": "cn-beijing-a", "NodeSpec": "rds.mysql.1c2g" } ]	实例的节点配置。
StorageType	String	是	LocalSSD	实例的存储类型。取值范围： LocalSSD：本地盘。 CloudESSD_FlexPL：FlexPL 云盘。 CloudESSD_PL0：PL0 云盘。 CloudESSD_HighPerf：高性能云盘。说明如需设定 StorageSpace 参数，StorageType 参数为必传。当 InstanceType 取值为 SingleNode 时，StorageType 取值只能为 CloudESSD_FlexPL、CloudESSD_PL0 或 CloudESSD_HighPerf。在不同接口中，该参数取值范围不同。具体规则如下：在以下接口中作为请求参数时，StorageType 的取值只能为 LocalSSD。 RestoreToCrossRegionInstance RestoreToNewInstanceFromUserTos 在部分接口中作为请求参数时，该参数的取值范围与原实例的存储类型有关，具体规则如下：原实例的存储类型为 LocalSSD时，不支持变更存储类型。原实例的存储类型为 CloudESSD_PL0 时，可取值为 CloudESSD_PL0、 CloudESSD_FlexPL 或 CloudESSD_HighPerf。涉及的接口是： RebuildDBInstance RestoreToNewInstance ModifyDBNodeSpec
StorageSpace	Integer	是	100	不同存储类型、不同规格对应的存储空间取值范围不同，关于存储空间取值范围的详细信息，请参见产品规格。单位为 GiB，步长 10GiB。
VpcId	String	是	vpc-2d70di2hrnbpc58ozfdx9****	私有网络（VPC） ID。可调用 DescribeVpcs 查询。说明不支持使用共享 VPC。
SubnetId	String	是	subnet-2d70dj20bob9c58ozfek6****	子网 ID。可调用 DescribeSubnets 通过指定 VpcId 和 ZoneId （主节点或备节点所在的可用区）查询可用的子网。
InstanceName	String	否	Name123	实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度应在 1~128 个字符之间。说明如果不填实例名称，则实例名称与实例 ID 一致。云数据库 MySQL 版最多支持批量创建 50 个实例。批量创建时，如果不填写实例名称，批量创建的实例均会采用实例 ID 作为实例名称。如果填写了实例名称，则会自动在实例名称后加序号。如指定实例名称为“测试实例”，批量创建 3 个，这 3 个实例的名称将分别为“测试实例-1”、“测试实例-2”和“测试实例-3”。支持使用特定语法为实例指定有序的实例名称，该语法为name_prefix[begin_number,bits]name_suffix。如指定实例名称为“名称前缀[0,2]名称后缀”，批量创建 3 个，这 3 个实例的名称将分别为“名称前缀00名称后缀”、“名称前缀01名称后缀”和“名称前缀02名称后缀”。更多详细信息，请参见有序实例名称设置规则。
SuperAccountName	String	否	Test1	高权限账号名称。不传此参数默认不创建高权限账号。高权限账号名称命名规则如下：账号长度为 2~32 个字符。以字母开头，以字母或数字结尾。由字母、数字、下划线（_）或中划线（-）组成。不能使用某些预留字，被禁用的预留字请参见禁用词列表。账号名称在实例内必须是唯一的。
SuperAccountPassword	String	否	Test@123456	高权限账号的密码。密码规则如下：长度为 8~32 个字符。由大写字母、小写字母、数字、特殊字符中的至少三种组成。特殊字符为 !#$%&()*+,-.=?@^_\|/。
LowerCaseTableNames	String	否	1	表名是否区分大小写，默认取值为“1”。后端忽略大小写。取值范围： 0：表名被存储成固定且表名称大小写敏感。 1：表名将被存储成小写且表名称大小写不敏感。
DBTimeZone	String	否	UTC +08:00	时区。支持 UTC -12:00 ~ +13:00。默认值为 Region 所在的 TimeZone。
DBParamGroupId	String	否	mysql-sys-6013c7b8f7ef****	参数模板 ID。默认值为数据库引擎版本对应的默认参数模板。
ProjectName	String	否	Test	实例所属的项目。如需在创建时指定项目，需确保项目已存在。可通过调用 ListProjects 接口查询项目列表，也可通过调用 CreateProject 接口创建新的项目。
ChargeInfo	Object of ChargeInfoObject	是	{ "ChargeType": "PostPaid" }	付费方式。
AllowListIds	Array of String	否	[ "acl-a29be2559dc4406883d358892b90**", "acl-ded4c0b707e44efd8f0dbc4e88f5**" ]	白名单 ID。如需绑定多个白名单，白名单 ID 用英文逗号（,）分隔。一个实例最多可绑定 100 个白名单。
Port	Integer	否	3306	默认终端的私网端口。端口号的取值范围为 1000~65534，默认值为 3306。创建新的连接终端或开启新地址时，将使用默认终端的私网端口实时配置为默认端口。
InstanceTags	Array of TagObject	否	[{"Key":"key", "Value":"value"}]	实例标签。每个 MySQL 实例最多可绑定 50 个标签。单次操作中最多可添加 20 个标签。
MaintenanceWindow	Object of MaintenanceWindowObject	否	{ "DayKind": "Week", "DayOfWeek": [ , "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] "MaintenanceTime": "18:00Z-21:59Z" }	在创建实例时指定实例的可维护时间段。该字段为可选，不设置时默认为一周内每一天的 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）。
DeletionProtection	String	否	Enabled	是否启用实例的删除保护功能。取值： Enabled：是。 Disabled：否。默认值。
ProxyNodeCustom	Object of ProxyNodeCustom	否	请参见请求示例。	实例的数据库代理配置。说明该字段仅在 InstanceType 取值为 MultiNode 时必选。该字段在 InstanceType 取值为 DoubleNode 或 SingleNode 时不生效。
EnableExternalReplication	Boolean	否	false	是否开启原生复制。取值： true：是。 false：否。默认值。说明该配置仅在 InstanceType 取值为 SingleNode 时生效。
EngineType	String	否	RocksDB	数据库引擎类型。取值： InnoDB：InnoDB 引擎。 RocksDB：RocksDB 引擎。说明作为请求参数时，默认值为 InnoDB。
PrivateIpAddress	String	否	192.168.xxx.xxx	指定实例的默认终端在指定私有网络和子网下的 IP 地址。说明如不设定，则自动为实例的默认终端分配指定私有网络和子网下的 IP 地址。
AutoStorageScalingConfig	Object of AutoStorageScalingConfig	否	请参见请求示例。	自动扩容配置。
AutoUpgradeMinorVersion	String	否	Auto	实例内核小版本的升级策略。取值： Auto：自动升级。当发布新的内核小版本时，实例将在设置的可维护时间段内，自动升级至最新的内核小版本。 Manual：手动升级。当发布新的内核小版本时，您需要在控制台手动至最新的内核小版本。具体操作，请参见手动升级实例内核小版本。说明若实例的内核小版本超出维护周期时，系统会暂时忽略内核小版本的升级策略设定，自动为实例升级内核小版本。

NodeInfoObject

参数	类型	是否必选	示例值	描述
NodeId	String	否	mysql-050b3e08****-r6e25	节点 ID。说明创建实例或新增节点时无需传入，变更节点配置或删除节点时必传。
NodeType	String	是	Primary	节点类型，取值： Primary：主节点。 Secondary：备节点。 ReadOnly：只读节点。说明在查询实例价格详情接口（DescribeDBInstancePriceDetail）中，该字段为可选。在增加节点（CreateDBNodes）时，该字段取值只能为 ReadOnly（双节点实例）或 Secondary（多节点实例）。对于双节点实例，主节点和备节点有且只有 1 个，只读节点可选 0~10 个。对于多节点实例，主节点有且只有 1 个，最多可添加 8 个备节点，最少需有 1 个备节点。建议预留一个不承载业务的独立备节点，以便在必要时将其切换为主节点。若因未设置独立备节点致使所有备节点主备延迟过高，进而导致主节点切换失败，云数据库 MySQL 版不承担相关责任。
NodeSpec	String	是	rds.mysql.1c2g	节点规格。关于节点规格的详细信息，请参见产品规格。说明备节点的规格需与主节点的规格保持一致。只读节点规格可低于主节点的规格。但需注意，当只读节点规格低于主节点规格时，可能会因为主节点负载过高导致只读节点存在延迟甚至只读节点 OOM。建议为只读节点选择采与主节点相同或更高的规格。如 StorageType 取值为 CloudESSD_FlexPL 或 CloudESSD_PL0，NodeSpec 只能传入通用规格。
ZoneId	String	是	cn-beijing-a	节点所在可用区，可调用 DescribeAvailabilityZones 接口查询。在创建实例和新增节点时必传，变更节点配置或删除节点时可不传。说明一个实例的节点最多可分布在三个可用区。在一次变配中，最多可增删三个可用区下的节点。
NodeOperateType	String	否	Modify	操作类型。创建实例时无需传入，修改节点配置时需要传入。取值范围： Create：增加。 Modify：修改。说明在增加节点（CreateDBNodes）时，该字段只能取值为 Create。在变更配置时，该字段只能取值为Modify。填写为 Delete 时，该取值无实际意义。

ChargeInfoObject

参数	类型	是否必选	示例值	描述
ChargeType	String	是	PostPaid	付费类型。取值： PostPaid：按量付费（后付费）。 PrePaid：包年包月（预付费）。
AutoRenew	Boolean	否	true	预付费场景下是否到期自动续费。取值范围： true：到期自动续费。 false：到期不自动续费。说明 ChargeType 取值为 PrePaid 时，此参数必填。 ChargeType 取值为 PostPaid 时，不需要传入此参数。即使传入参数，系统也会自动忽略，配置不生效。
PeriodUnit	String	否	Month	预付费场景下的购买周期。取值范围： Month：购买周期为月。 Year：购买周期为年。说明 ChargeType 取值为 PrePaid 时，此参数必填。 ChargeType 取值为 PostPaid 时，不需要传入此参数。即使传入参数，系统也会自动忽略，配置不生效。
Period	Integer	否	1	预付费场景下的购买时长。该参数的取值范围取决于 PeriodUnit 的取值： PeriodUnit 取值为 Month 时，Period 的取值为 1~9。 PeriodUnit 取值为 Year 时，Period 的取值为 1~3。说明 ChargeType 取值为 PrePaid 时，此参数必填。 ChargeType 取值为 PostPaid 时，不需要传入此参数。即使传入参数，系统也会自动忽略，配置不生效。
Number	Integer	否	1	实例购买数量。取值范围为 1~50。默认值为 1。说明在 RestoreToNewInstance 与 RestoreToCrossRegionInstance 接口中，仅支持为该字段取值 1。不支持在批量创建实例时分别为实例指定名称。在批量创建实例时：如在 InstanceName 参数指定了实例名称，则会在指定的实例名称后加序号为批量创建的实例命名。如未在 InstanceName 参数指定实例名称，则会以实例 ID 为实例命名。

TagObject

参数	类型	是否必选	示例值	描述
Key	String	是	tagkey	实例标签的标签键。标签键的设置规则如下：支持任何语言字母或文字（如中文、英文字母等）、数字、空格。支持特殊字符：_.:/=+-@。 volc: 为系统预留的标签键，添加标签时，标签键的开头不能设置为任何大小写形式的 volc:。标签键的长度需为 1~128 个字符。
Value	String	否	tagvalue	实例标签的标签值。标签值的设置规则如下：支持任何语言字母或文字（如中文、英文字母等）、数字、空格。支持特殊字符：_.:/=+-@。标签值的长度需为 0~256 个字符，即标签值可以为空。

MaintenanceWindowObject

参数	类型	是否必选	示例值	描述
DayKind	String	否	Week	可维护周期粒度，取值为 Week，周。
DayOfWeek	Array of String	否	["Monday","Tuesday"]	指定修改每周哪一天的可维护时间段，取值为：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday，可多选。如果不指定该值或者为空，则默认一周七天都指定。
MaintenanceTime	String	否	22:00Z-02:00Z	实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC 时间）。

ProxyNodeCustom

参数	类型	是否必选	示例值	描述
CpuNum	Integer	否	4	实例数据库代理服务的 CPU 核数。取值范围：上限：1024。推荐代理核数为实例所有可服务节点总 CPU 数0.25，结果向上取整。代理核数的取值下限为 2 与主节点 CPU 核数0.125之间的较大值。

AutoStorageScalingConfig

参数	类型	是否必选	示例值	描述
EnableStorageAutoScale	Boolean	是	true	是否开启存储空间的自动扩容功能。取值： true：是。 false：否。说明 StorageConfig 作为请求参数时，如 EnableStorageAutoScale取值为 false，可不传入 StorageThreshold 和 StorageUpperBound 参数。
StorageThreshold	Integer	是	20	触发自动扩容的可用存储空间占比。取值范围为 10~50，默认值为 10，单位为 %。
StorageUpperBound	Integer	是	3000	可自动扩容的存储空间上限。该字段的取值下限为实例存储空间+20 GiB；取值上限为实例主节点规格对应的存储空间取值范围的上限，单位为 GiB。关于不同规格可选择存储空间取值范围的详细信息，请参见产品规格。
ScalingDetectNode	String	否	MasterNode	检测是否需进行自动扩容的节点范围。取值： MasterNode：主节点。 MasterSlaveNodes：主备节点。 AllNodes：所有节点。说明该参数作为请求参数时，默认值为 MasterNode。对于多节点实例，该参数取值为 MasterSlaveNodes 和 AllNodes 的效果相同。对于单节点实例，该参数取值为 MasterNode、MasterSlaveNodes 和 AllNodes 的效果相同。

返回参数

参数	类型	示例值	描述
InstanceId	String	mysql-06f13c93****	实例 ID。
OrderId	String	Order709899242175681****	订单 ID。

示例

请求示例

POST /?Action=CreateDBInstance&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
    "DBEngineVersion": "MySQL_5_7",​
    "NodeInfo": [​
        {​
            "NodeType": "Primary",​
            "ZoneId": "cn-beijing-a",​
            "NodeSpec": "rds.mysql.1c2g"​
        },​
        {​
            "NodeType": "Secondary",​
            "ZoneId": "cn-beijing-b",​
            "NodeSpec": "rds.mysql.1c2g"​
        }​
    ],​
    "StorageType": "LocalSSD",​
    "StorageSpace": 20,​
    "SubnetId": "subnet-2gcy3ey5i9reo50ztyzo6****",​
    "VpcId": "vpc-3jhamu8itr5ds3pncmf9q****",​
    "AllowListIds": [​
        "acl-3929ba6fd27049e88ee772dc7b46****"​
    ],​
    "Port": 3306,​
    "InstanceName": "测试样例",​
    "ChargeInfo": {​
        "ChargeType": "PostPaid",​
        "Number": 1​
    },​
    "MaintenanceWindow": {​
        "DayKind": "Week",​
        "DayOfWeek": [​
            "Monday",​
            "Tuesday",​
            "Wednesday",​
            "Thursday",​
            "Friday",​
            "Saturday",​
            "Sunday"​
        ],​
        "MaintenanceTime": "18:00Z-21:59Z"​
    }​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230508104043BEB227FB****F73A1436",​
        "Action": "CreateDBInstance",​
        "Version": "2022-01-01",​
        "Service": "rds_mysql",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "InstanceId": "mysql-06f13c93****",​
        "OrderId": "Order7230634971667632428"​
    }​
}​

错误码

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

最近更新时间：2026.08.05 14:42:12

这个页面对您有帮助吗？

有用

无用