调用CreateDBInstance接口创建AnalyticDB PostgreSQL版实例。

使用说明

本接口一般是在发布新应用或业务扩展等需要创建新的AnalyticDB PostgreSQL版实例资源时使用。

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

QPS限制

本接口的单用户QPS限制默认为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

本文档中的QPS仅为默认参考值,准确信息请参见API速率配额列表

调试

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

请求参数

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

系统规定参数。取值:CreateDBInstance

RegionId String cn-hangzhou

地域ID。

说明 您可以调用DescribeRegions接口查看可用的地域ID。
ZoneId String cn-hangzhou-i

可用区ID。

说明 您可以调用DescribeRegions接口查看可用的可用区ID。
EngineVersion String 6.0

引擎版本,取值为6.0。

Engine String gpdb

数据库引擎,取值为gpdb

DBInstanceClass String gpdb.group.segsdx1

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

说明 创建存储预留模式实例必须传入该参数。
DBInstanceGroupCount String 2

计算组数量。取值为:2、4、8、12、16、24、32、64、96、128。

说明 创建存储预留模式实例必须传入该参数。
DBInstanceDescription String test

实例描述。

SecurityIPList String 127.0.0.1

IP白名单。

127.0.0.1表示禁止任何外部IP访问,您可以在实例创建完成后调用ModifySecurityIps接口修改IP白名单。

PayType String Prepaid

计费类型:

  • Postpaid:按量付费
  • Prepaid:包年包月
说明
  • 如果不填,则会默认为按量付费。
  • 包年包月计费模式下,一次性购买一年及以上时长时会有一定优惠,建议您按需选择计费类型。
Period String Month

购买资源的时长单位。取值如下:

  • Month:月
  • Year:年
说明 创建包年包月计费类型的实例时必须传入该参数。
UsedTime String 1

购买资源的时长。取值如下:

  • PeriodMonth时,取值为1~9。
  • PeriodYear时,取值为1~3。
说明 创建包年包月计费类型的实例时必须传入该参数。
ClientToken String 0c593ea1-3bea-11e9-b96b-88**********

幂等性校验。更多信息,请参见如何保证幂等性

InstanceNetworkType String VPC

实例网络类型,取值为VPC

说明
  • 公共云仅支持VPC网络。
  • 如果不填,则默认为VPC类型。
VPCId String vpc-bp*******************

VPC ID。

说明
  • VPCId必填。
  • VPC所在地域必须与RegionId保持一致。
VSwitchId String vsw-bp*******************

vSwitch ID。

说明
  • vSwitchId必填。
  • vSwitch所在可用区必须与ZoneId保持一致。
SegStorageType String cloud_essd

磁盘存储类型,取值说明:

  • cloud_essd:ESSD云盘。
  • cloud_efficiency:高效云盘。
说明
  • 创建存储弹性模式实例必须传入该参数。
  • 存储弹性模式基础版实例仅支持ESSD云盘。
InstanceSpec String 2C16G

计算节点规格。

存储弹性模式高可用版取值如下:

  • 2C16G
  • 4C32G
  • 16C128G

存储弹性模式基础版取值如下:

  • 2C8G
  • 4C16G
  • 8C32G
  • 16C64G

Serverless版本取值如下:

  • 4C16G
  • 8C32G
说明
  • 创建存储弹性模式实例和Serverless版本实例必须传入该参数。
  • Serverless版本公测期间(2022年01月01日~2022年01月31日),仅支持创建4C16G规格。
SegNodeNum String 4

计算节点个数,取值说明:

  • 存储弹性模式高可用版取值范围为4~512,取值需为4的倍数。
  • 存储弹性模式基础版取值范围为2~512,取值需为2的倍数。
  • Serverless版本取值范围为2~512,取值需为2的倍数。
说明
  • 创建存储弹性模式实例和Serverless版本实例必须传入该参数。
  • Serverless版本公测期间(2022年01月01日~2022年01月31日),最多支持创建12个计算节点。
MasterNodeNum String 1

Master节点数量,取值为1~2。

说明 如果不填,则默认为1个Master节点。
DBInstanceMode String StorageElastic

实例资源类型,取值说明:

  • StorageElastic:存储弹性模式。
  • Serverless:Serverless版本。
  • Classic:存储预留模式。
说明 该参数必填。
StorageType String null

该参数已废弃,无需传入该参数。

DBInstanceCategory String HighAvailability

实例系列。取值说明:

  • HighAvailability:高可用版。
  • Basic:基础版。
说明 创建存储弹性模式实例必须传入该参数。
StorageSize Long 200

存储空间大小,单位GB,取值范围为50~4000。

说明 创建存储弹性模式实例必须传入该参数。

返回数据

名称 类型 示例值 描述
RequestId String 5414A4E5-4C36-4461-95FC-************

请求ID。

DBInstanceId String gp-bp***************

实例ID。

Port String 3432

该参数已废弃,故不会返回参数值。

您可以通过DescribeDBInstanceAttribute接口查看实例的端口号。

ConnectionString String gp-bp***************.gpdb.rds.aliyuncs.com

该参数已废弃,故不会返回参数值。

您可以通过DescribeDBInstanceAttribute接口查看实例的连接地址。

OrderId String 111111111111

订单编号。

示例

请求示例

http(s)://gpdb.aliyuncs.com/?Action=CreateDBInstance
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-i
&EngineVersion=6.0
&Engine=gpdb
&DBInstanceDescription=test
&SecurityIPList=127.0.0.1
&PayType=Prepaid
&Period=Month
&UsedTime=1
&InstanceNetworkType=VPC
&VPCId=vpc-bp*******************
&VSwitchId=vsw-bp*******************
&SegStorageType=cloud_essd
&InstanceSpec=2C16G
&SegNodeNum=4
&MasterNodeNum=1
&DBInstanceMode=StorageElastic
&DBInstanceCategory=HighAvailability
&StorageSize=200
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDBInstanceResponse>
    <RequestId>5414A4E5-4C36-4461-95FC-************</RequestId>
    <DBInstanceId>gp-bp***************</DBInstanceId>
    <OrderId>111111111111</OrderId>
</CreateDBInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "5414A4E5-4C36-4461-95FC-************",
  "DBInstanceId" : "gp-bp***************",
  "OrderId" : "111111111111"
}

错误码

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