创建RDS实例_实例_API 参考_云数据库 RDS

请确保在使用该接口前，已充分了解RDS产品的收费方式和价格。

关于RDS实例的规格，请参见实例规格表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	CreateDBInstance	系统规定参数。取值：CreateDBInstance。
DBInstanceClass	String	是	rds.mysql.s1.small	实例规格。详情请参见主实例规格表。
DBInstanceNetType	String	是	Internet	实例的网络连接类型。取值： Internet：公网连接 Intranet：内网连接
DBInstanceStorage	Integer	是	20	实例存储空间。单位：GB。每5GB进行递增，取值范围请参见实例规格表。
Engine	String	是	MySQL	数据库类型。取值： MySQL SQLServer PostgreSQL PPAS MariaDB
EngineVersion	String	是	5.6	数据库版本。取值： MySQL：5.5/5.6/5.7/8.0 SQL Server：2008r2/08r2_ent_ha/2012/2012_ent_ha/2012_std_ha/2012_web/2014_std_ha/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent/2019_ent PostgreSQL：9.4/10.0/11.0/12.0 PPAS：9.3/10.0 MariaDB：10.3
PayType	String	是	Postpaid	实例的付费类型。取值： Postpaid：后付费（按量付费） Prepaid：预付费（包年包月）
RegionId	String	是	cn-hangzhou	地域ID。可以通过接口DescribeRegions查看可用的地域ID。
SecurityIPList	String	是	10.23.12.27/24	该实例的IP白名单。多条记录请以英文逗号（,）隔开，不可重复，最多1000条记录。支持如下两种格式： IP地址形式，例如：10.23.12.24。 CIDR形式，例如：10.23.12.24/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。
SystemDBCharset	String	否	gbk	字符集。该参数已弃用。
DBInstanceDescription	String	否	测试数据库	实例名称。长度为2~255个字符。以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。说明不能以 http:// 和 https:// 开头。
ClientToken	String	否	ETnLKlblzczshOTUbOCzxxxxxxxxxx	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。
ZoneId	String	否	cn-hangzhou-b	主节点可用区ID。说明指定了VPC和交换机时，为匹配交换机对应的可用区，该参数必填。对于高可用版实例，还需传入ZoneIdSlave1，以此决定实例是单可用区部署还是多可用区部署。对于三节点企业版实例，还需传入ZoneIdSlave1和ZoneIdSlave2，以此决定实例是单可用区部署还是多可用区部署。
ZoneIdSlave1	String	否	cn-hangzhou-c	备节点可用区ID。如果和ZoneId相同，则为单可用区部署；如果和ZoneId不同，则为多可用区部署。
ZoneIdSlave2	String	否	cn-hangzhou-d	日志节点可用区ID。如果和ZoneId相同，则为单可用区部署；如果和ZoneId不同，则为多可用区部署。
InstanceNetworkType	String	否	Classic	实例的网络类型。取值： VPC：VPC网络 Classic：经典网络（默认）说明云盘实例只支持VPC网络，例如想创建基础版实例，本参数必须传入VPC。如果数据库类型Engine=MariaDB，该参数必填。
ConnectionMode	String	否	Standard	实例的访问模式。取值： Standard：标准访问模式 Safe：数据库代理模式默认为RDS系统分配。说明 SQL Server 2012/2016/2017只支持标准访问模式。
VPCId	String	否	vpc-xxxxxxxxxxxx	专有网络（VPC） ID。说明需要网络类型InstanceNetworkType=VPC。
VSwitchId	String	否	vsw-xxxxxxxxxxx	虚拟交换机（VSwitch） ID。多个值用英文逗号（,）隔开。说明需要网络类型InstanceNetworkType=VPC。
PrivateIpAddress	String	否	172.16.201.69	设置实例的内网IP。需要在指定交换机的IP地址范围内。系统默认通过VPCId和VSwitchId自动分配。
UsedTime	String	否	2	指定购买时长。取值：当参数Period=Year时，UsedTime取值为1~3。当参数Period=Month时，UsedTime取值为1~9。说明若付费类型为Prepaid则该参数必须传入。
Period	String	否	Year	指定预付费实例为包年或者包月类型。取值： Year：包年 Month：包月说明若付费类型为Prepaid则该参数必须传入。
ResourceGroupId	String	否	rg-acfmyxxxxxxxxxx	资源组ID。
DBInstanceStorageType	String	否	cloud_ssd	实例存储类型。取值： local_ssd：本地SSD盘（推荐） cloud_ssd：SSD云盘 cloud_essd：ESSD PL1云盘 cloud_essd2：ESSD PL2云盘 cloud_essd3：ESSD PL3云盘
BusinessInfo	String	否	121436975448952	业务扩展参数。
EncryptionKey	String	否	0d24xxxx-da7b-4786-b981-9a164dxxxxxx	同地域内的云盘加密的密钥ID。您可以在密钥管理服务控制台查看密钥ID，也可以创建新的密钥。详情请参见管理密钥。说明传入此参数表示开启云盘加密（开启后无法关闭），并且需要传入RoleARN。
RoleARN	String	否	acs:ram::1406xxxxxx:role/aliyunrdsinstanceencryptiondefaultrole	主账号授权RDS云服务账号访问KMS权限的全局资源描述符（ARN）。您可以在RAM访问控制台复制ARN的内容。说明在控制台自助授权请参见授权RDS访问KMS。
AutoRenew	String	否	true	实例是否自动续费。取值：true \| false 说明按月购买，则自动续费周期为1个月。按年购买，则自动续费周期为1年。
Category	String	否	HighAvailability	实例系列。取值： Basic：基础版 HighAvailability：高可用版 AlwaysOn：集群版 Finance：三节点企业版
DedicatedHostGroupId	String	否	dhg-4nxxxxxxx	在专属集群内创建实例时指定专属集群ID。
TargetDedicatedHostIdForMaster	String	否	i-bpxxxxxxx1	在专属集群内创建实例时，指定主实例的主机ID。
TargetDedicatedHostIdForSlave	String	否	i-bpxxxxxxx2	在专属集群内创建实例时，指定备实例的主机ID。
TargetDedicatedHostIdForLog	String	否	i-bpxxxxxxx3	在专属集群内创建实例时，指定日志实例的主机ID。说明暂不支持传入此参数。
DBParamGroupId	String	否	rpg-sys-xxxx	参数模板ID。
DBTimeZone	String	否	+08:00	UTC时区。取值范围为-12:59 ~ +13:00。说明不传入时，默认时区为地域默认时区。本地SSD盘实例可以命名时区，例如Asia/Hong_Kong。详情请参见各引擎官方文档。
DBIsIgnoreCase	String	否	1	表名是否区分大小写。取值： 1：不区分大小写（默认） 0：区分大小写
TargetMinorVersion	String	否	rds_20200229	指定创建的MySQL实例的小版本，仅在创建MySQL实例时需要传入。格式：实例版本_数字版本号。例如rds_20200229、xcluster_20200229或xcluster80_20200229。说明如下： rds：高可用版或基础版 xcluster：MySQL 5.7三节点企业版 xcluster80：MySQL 8.0三节点企业版说明数字版本号请参见AliSQL 小版本Release Notes。
StorageAutoScale	String	否	Disable	存储空间自动扩容开关，取值： Enable：开启 Disable：关闭
StorageThreshold	Integer	否	50	存储空间自动扩容触发阈值（百分比）。取值： 10 20 30 40 50 说明 StorageAutoScale为Enable时必填。
StorageUpperBound	Integer	否	2000	存储空间自动扩容的总存储空间上限值，即自动扩容不会导致实例总存储空间超过该值。单位：GB。取值需≥0。说明 StorageAutoScale为Enable时必填。

返回数据


名称	类型	示例值	描述
DBInstanceId	String	rm-uf6wjk5xxxxxxxxxx	实例ID。
OrderId	String	1007893702xxxxx	订单ID。
ConnectionString	String	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com	数据库连接地址。说明参数DBInstanceNetType决定该地址为内网或外网。
Port	String	3306	数据库连接端口。说明参数DBInstanceNetType决定该端口为内网或外网。
RequestId	String	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC	请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=CreateDBInstance
&RegionId=cn-hangzhou
&Engine=MySQL
&EngineVersion=5.6
&DBInstanceClass=rds.mysql.s1.small
&DBInstanceStorage=20
&DBInstanceNetType=Internet
&PayType=Postpaid
&SecurityIPList=10.23.12.27/24
&<公共请求参数>

正常返回示例

XML 格式

<CreateDBInstanceResponse>
	  <OrderId>1007893702xxxxx</OrderId>
	  <ConnectionString>rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com</ConnectionString>
	  <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
	  <Port>3306</Port>
	  <RequestId>1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC</RequestId>
</CreateDBInstanceResponse>

JSON 格式

{
    "OrderId": "1007893702xxxxx",
    "ConnectionString": "rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com",
    "DBInstanceId": "rm-uf6wjk5xxxxxxx",
    "Port": "3306",
    "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC"
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidZoneId.NotSupported	The Specified vpc Zone not supported.	当前可用区不支持生产 VPC 实例，请您更换可用区再试。
400	InvalidPaymentMethod.Incomplete	No payment method is specified for your account. We recommend that you add a payment method.	您的账户暂无有效支付方式，请添加支付方式。
400	InvalidPaymentMethod.Missing	No payment method is specified for your account. We recommend that you add a payment method.	您的账户暂无有效支付方式，请添加支付方式
400	SYSTEM.CONCURRENT_OPERATE	Concurrent operation is detected.	系统并行运行。
400	ZoneId.NotMatchWithCategory	The number of ZoneId specified does not match with category.	指定的ZoneId数量与选择类型不匹配。

访问错误中心查看更多错误码。