文档中心 > CreateDBInstance
CreateDBInstance

最近更新时间:2022-09-26

请求路径:/v3/api/rds

请求方法:POST

接口描述:创建RDS实例

请求参数

名称

类型

是否必选

示例值

描述

Action

String

CreateDBInstance

系统规定参数。取值:CreateDBInstance

请求消息体

名称

类型

是否必选

示例值

描述

Region

String

cn-beijing

地域ID

Engine

String

mysql

数据库类型。取值:mysql、sqlserver-ee、postgresql

EngineVersion

String

5.7

数据库版本,取值:

  • MySQL:5.7、8.0

  • SQL Server:2016-enterprise、2019-enterprise

  • PostgreSQL:11.6、13

MultiAZ

Boolean

false

是否支持多可用区部署。目前只支持单可用区,默认值为否

AvailabilityZone

String

cb-bejing-a

主节点可用区ID,目前只支持单可用区,根据Region上送对应的可用区ID。

VpcId

String

vpc-wrxxxxxxxx

VPC   ID

SubnetId

String

619a6d2a3fxxxxxxxxxxxxxxx

子网ID

AllocatedStorage

Integer

10

实例存储空间,单位:GB。取值:10~2048

StorageType

String

local

存储类型,目前只支持local

ChargeMode

String

pre-paid

计费模式。取值:

  • pre-paid(预付费包年包月)

  • post-paid(后付费,目前按小时计费, 后续优化到按秒)

  • post-paid-monthly(按日月结) free-trial 免费试用

Duration

Integer

6

购买时长,单位:月。当chargemode为pre-paid时为必选 ChargeMode只支持month。取值:1,2,3,6,12

Quantity

Integer

1

购买实例个数,取值:1~5

InstanceMode

String

SE

实例系列,取值:  

  • SE:基础版。

  • HA:高可用版。

  • EE:集群/三节点企业版(仅mysql8.0有集群规格)。

InstanceType

String

normal

实例类型。取值:

  • -normal:常规实例

  • -read_only:只读实例。取值仅可以创建mysql5.7基础版实例

DBInstanceClass

String

db.s1.large

实例规格码

DBInstanceName

String

openapi-test

实例名,可自定义

DBCaseSensitive

String

true

表名是否区分大小写,仅mysql8.0版本可以传此参数。取值:

  • false:不区分大小写。

  • true:区分大小写(默认)

Port

Integer

3306

数据库服务端口,目前采用默认端口,不支持修改。


  • PostgreSQL默认端口:5432


  • MySQL默认端口:3306

  • SQL Server默认端口:1433

SourceInstanceId

String

mysql-lv1xxxxxxx

源实例ID,当InstanceType为read_only时必选,当前只支持MySQL实例,取值:仅MySQL5.7高可用版实例可以传此参数

ProjectId

String

projecttest1

项目ID,企业用户需要填写, 非企用户会使用默认项目值

返回参数

状态码:200

名称

类型

示例值

描述

DBInstanceId

String

mysql-lv1xxxxxxx

实例ID,多个实例ID逗号分隔

OrderId

String

11491951915554xxxxxxx

订单ID。

RequestId

String

rm-uf6wjk5xxxxxxxxxx

请求ID。

示例

请求示例

POST https://api.unicloud.com/v3/api/rds?

Action=CreateDBInstance

body
{
 "Region":"cn-test-xxx",
 "Engine":"mysql",
 "EngineVersion":"8.0",
 "MultiAZ":false,
 "AvailabilityZone":"cn-test-1",
 "VpcId":"vpc-xxx",
 "SubnetId":"vsnet-xxxx",
 "AllocatedStorage": 10,
 "StorageType":"local",
 "ChargeMode":"pre-paid",
 "Duration":1,
 "Quantity":1,
 "InstanceMode":"HA",
 "InstanceType":"normal",
 "DBInstanceClass":"db.c1.medium",
 "DBInstanceName":"testDemo",
 "DBCaseSensitive":false,
 "Port":3306,
 "SourceInstanceId":"",
 "ProjectId":"rg-k7ektolcs21h"
}

返回示例

{
       "RequestId": "b9de1a62xxxxxx",
       "DBInstanceId": "mysql-xxxxxx",
       "OrderId": "72212xxxxxx"  
}