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

使用说明

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

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

QPS限制

本接口的单用户QPS限制默认为1000次/秒。超过限制，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：6.0版。
  • 7.0：7.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

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

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

幂等性校验。更多信息，请参见如何保证幂等性。
InstanceNetworkType String 否 VPC

实例网络类型，取值为VPC。

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

VPC ID。

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

vSwitch ID。

说明
  • vSwitchId必填。
  • vSwitch所在可用区必须与ZoneId保持一致。
PrivateIpAddress String 否 1.1.1.*

私有IP地址。
SegStorageType String 否 cloud_essd

磁盘存储类型，目前仅支持ESSD云盘，取值为：cloud_essd。

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

ESSD云盘的性能级别，取值如下：

  • pl0：PL0级别。
  • pl1：PL1级别。
  • pl2：PL2级别。
说明
  • 仅磁盘存储类型为ESSD云盘时，该参数生效。
  • 如果不填，则默认为PL1级别。
InstanceSpec String 否 2C16G

计算节点规格。

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

  • 2C16G
  • 4C32G
  • 16C128G

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

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

Serverless模式取值如下：

  • 4C16G
  • 8C32G
说明 创建存储弹性模式实例和Serverless模式实例必须传入该参数。
SegNodeNum String 否 4

计算节点个数，取值说明：

  • 存储弹性模式高可用版取值范围为4~512，取值需为4的倍数。
  • 存储弹性模式基础版取值范围为2~512，取值需为2的倍数。
  • Serverless模式取值范围为2~512，取值需为2的倍数。
说明 创建存储弹性模式实例和Serverless模式实例必须传入该参数。
MasterNodeNum String 否 1

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

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

实例资源类型，取值说明：

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

该参数已废弃，无需传入该参数。
DBInstanceCategory String 否 HighAvailability

实例系列。取值说明：

  • HighAvailability：高可用版。
  • Basic：基础版。
说明 创建存储弹性模式实例必须传入该参数。
ResourceGroupId String 否 rg-bp67acfmxazb4p****

实例所在的企业资源组ID。
StorageSize Long 否 200

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

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

是否在实例创建完成后，加载样本数据集，取值如下：

  • true：加载样本数据集。
  • false：不加载样本数据集。

如果不填，则默认为不加载样本数据集。
Tag.N.Key String 否 TestKey

标签键。限制如下：

  • 不允许为空字符串。
  • 最多支持128个字符。
  • 不能以aliyun和acs:开头，不能包含http://或者https://。
Tag.N.Value String 否 TestValue

标签值。限制如下：

  • 可以为空字符串。
  • 最多支持128个字符。
  • 不能以acs:开头，不能包含http://或者https://。
ServerlessResource Integer 否 32

计算资源阈值。取值范围8~32，步长为8，单位为ACU。默认值为32。

说明 仅Serverless自动调度模式实例需传入该参数。
IdleTime Integer 否 600

空闲释放等待时长。即当无业务流量的时长达到指定时长后，实例转为空闲状态。单位为秒，最小值为60，默认值为600。

说明 仅Serverless自动调度模式实例需传入该参数。
ServerlessMode String 否 Auto

Serverless实例的模式，取值如下：

  • Manual：手动调度，为默认值。
  • Auto：自动调度。
说明 仅Serverless模式实例需传入该参数。
EncryptionType String 否 CloudDisk

加密类型，取值说明：

  • NULL：不启用加密（默认值）。
  • CloudDisk：开通云盘加密，并通过EncryptionKey参数指定密钥。
说明 当前云盘加密开启后无法关闭。
EncryptionKey String 否 0d2470df-da7b-4786-b981-88888888****

密钥ID。

说明 如果参数EncryptionType的值为CloudDisk则需要通过该参数指定同地域内的加密密钥ID，否则为空。
VectorConfigurationStatus String 否 enabled

是否开启向量引擎优化。取值说明：

  • enabled：开启向量引擎优化。
  • disabled（默认）：不开启向量引擎优化。
说明
  • 对于主流分析场景、数仓场景、实时数仓等场景，建议不开启向量引擎优化。
  • 对于使用向量分析引擎用于AIGC、向量检索等场景用户，建议开启向量引擎优化。

返回数据

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

请求ID。
DBInstanceId String gp-bp12ga6v69h86****

实例ID。
Port String 3432

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

您可以通过DescribeDBInstanceAttribute接口查看实例的端口号。
ConnectionString String gp-bp12ga6v69h86****.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
&DBInstanceClass=gpdb.group.segsdx1
&DBInstanceGroupCount=2
&DBInstanceDescription=test
&SecurityIPList=127.0.0.1
&PayType=Prepaid
&Period=Month
&UsedTime=1
&ClientToken=0c593ea1-3bea-11e9-b96b-88**********
&InstanceNetworkType=VPC
&VPCId=vpc-bp19ame5m1r3oejns****
&VSwitchId=vsw-bp1cpq8mr64paltkb****
&PrivateIpAddress=1.1.1.*
&SegStorageType=cloud_essd
&SegDiskPerformanceLevel=pl1
&InstanceSpec=2C16G
&SegNodeNum=4
&MasterNodeNum=1
&DBInstanceMode=StorageElastic
&StorageType=null
&DBInstanceCategory=HighAvailability
&ResourceGroupId=rg-bp67acfmxazb4p****
&StorageSize=200
&CreateSampleData=false
&Tag=[{"Key":"TestKey","Value":"TestValue"}]
&ServerlessResource=32
&IdleTime=600
&ServerlessMode=Auto
&EncryptionType=CloudDisk
&EncryptionKey=0d2470df-da7b-4786-b981-88888888****
&公共请求参数

正常返回示例

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"
}

错误码

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