调用CreateDBInstance接口创建一个RDS实例。

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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDBInstance

系统规定参数,取值:CreateDBInstance

RegionId String cn-hangzhou

地域ID,可以通过接口DescribeRegions查看可用的地域ID。

Engine String MySQL

数据库类型,取值:

  • MySQL
  • SQLServer
  • PostgreSQL
  • PPAS
  • MariaDB
EngineVersion String 5.6

数据库版本,取值:

  • MySQL:5.5/5.6/5.7/8.0
  • SQL Server:2008r2/2012/2012_ent_ha/2012_std_ha/2012_web/2016_ent_ha/2016_std_ha/2016_web/2017_ent
  • PostgreSQL:9.4/10.0
  • PPAS:9.3/10.0
  • MariaDB:10.3
DBInstanceClass String rds.mysql.s1.small

实例规格,详见实例规格表

DBInstanceStorage Integer 20

实例存储空间,单位:GB。每5GB进行递增,详见实例规格表

DBInstanceNetType String Internet

实例的网络连接类型,取值:

  • Internet:公网连接;
  • Intranet:内网连接。
PayType String Postpaid

实例的付费类型,取值:

  • Postpaid:后付费(按量付费);
  • Prepaid:预付费(包年包月)。
SecurityIPList String 10.23.12.27/24

该实例的IP白名单,多个IP地址请以英文逗号(,)隔开,不可重复,最多1000个。支持如下两种格式:

  • IP地址形式,例如:10.23.12.24;
  • CIDR形式,例如:10.23.12.24/24(无类域间路由,24表示了地址中前缀的长度,范围为1~32)。
SystemDBCharset String GBK

字符集,取值:

  • MySQL/MariaDB实例:utf8、gbk、latin1、utf8mb4
  • SQL Server实例:Chinese_PRC_CI_AS、Chinese_PRC_CS_AS、SQL_Latin1_General_CP1_CI_AS、SQL_Latin1_General_CP1_CS_AS、Chinese_PRC_BIN
DBInstanceDescription String 测试数据库

实例名称,长度为2~256个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。

说明 不能以 http:// 和 https:// 开头。
ClientToken String ETnLKlblzczshOTUbOCzxxxxxxxxxx

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

ZoneId String cn-hangzhou-b

可用区ID。可以通过接口DescribeRegions查看可用区ID。

说明 指定了VPC和交换机时,为匹配交换机对应的可用区,该参数必填。
InstanceNetworkType String Classic

实例的网络类型,取值:

  • VPC:VPC网络;
  • Classic:经典网络。

默认创建经典网络类型的实例。

说明
  • SQL Server2017集群版只支持VPC网络;
  • 如果数据库类型为MariaDB,该参数必填。
ConnectionMode String Standard

实例的访问模式,取值:

  • Standard:标准访问模式;
  • Safe:数据库代理模式。

默认为RDS系统分配。

说明 SQL Server 2012/2016/2017只支持标准访问模式。
VPCId String vpc-xxxxxxxxxxxx

VPC ID。

说明 如果数据库类型为MariaDB,该参数必填。
VSwitchId String vsw-xxxxxxxxxxx

VSwitch ID,多个值用英文逗号(,)隔开。

说明 如果数据库类型为MariaDB,该参数必填。
PrivateIpAddress String 172.16.201.69

设置实例的内网IP,需要在指定交换机的IP地址范围内。系统默认通过VPCIdVSwitchId自动分配。

Period String Year

指定预付费实例为包年或者包月类型,取值:

  • Year:包年;
  • Month:包月。
说明 若付费类型为Prepaid则该参数必须传入。
UsedTime String 2

指定购买时长,取值:

  • 当参数PeriodYear时,UsedTime取值为1~3
  • 当参数PeriodMonth时,UsedTime取值为1~9
说明 若付费类型为Prepaid则该参数必须传入。
AutoRenew String true

实例是否自动续费,取值:true | false

说明
  • 按月购买,则自动续费周期为1个月;
  • 按年购买,则自动续费周期为1年。
DBInstanceStorageType String cloud_ssd

实例存储类型,取值:

  • local_ssd/ephemeral_ssd:本地SSD盘(推荐);
  • cloud_ssd:SSD云盘;
  • cloud_essd:ESSD云盘。
BusinessInfo String 121436975448952

业务扩展参数。

Category String HighAvailability

实例系列,取值:

  • Basic:基础版;
  • HighAvailability:高可用版;
  • AlwaysOn:集群版;
  • Finance:金融版(仅支持中国站)。

返回数据

名称 类型 示例值 描述
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 格式

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidZoneId.NotSupported The Specified vpc Zone not supported. 当前可用区不支持生产 VPC 实例,请您更换可用区再试。

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