調用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。多可用性區域用英文冒號(:)分隔。

说明 指定了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

業務擴充參數。

返回資料

名稱 類型 樣本值 描述
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 執行個體,請您更換可用性區域再試。

訪問錯誤中心查看更多錯誤碼。