调用CreateECSDBInstance接口创建存储弹性模式的AnalyticDB PostgreSQL版实例。

使用说明

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

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

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值：CreateECSDBInstance。
RegionId String 是 cn-hangzhou

地域ID。

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

可用区ID。

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

引擎版本，取值为6.0。

Engine String 是 gpdb

数据库引擎，取值为gpdb。

InstanceSpec String 是 2C16G

Segment节点规格。

高可用版取值如下：

  • 2C16G
  • 4C32G
  • 16C128G

基础版取值如下：

  • 2C8G
  • 4C16G
  • 8C32G
  • 16C64G
说明 如果您传入了基础版的规格，则DBInstanceCategory参数的值必须为Basic。
SegNodeNum Integer 是 4

Segment节点数量。

  • 高可用版取值范围为4~512。
  • 基础版取值范围为2~512。
SegStorageType String 是 cloud_essd

存储磁盘类型。

高可用版取值如下：

  • cloud_essd：ESSD云盘
  • cloud_efficiency：高效云盘

基础版取值如下：

  • cloud_essd：ESSD云盘
StorageSize Integer 是 200

存储空间大小，单位GB，取值范围为50~4000。
DBInstanceDescription String 否 测试用

实例描述。
SecurityIPList String 否 127.0.0.1

IP白名单。默认为127.0.0.1。

PayType String 否 Prepaid

计费类型：

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

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

  • Month：月
  • Year：年
说明 仅当PayType为Prepaid时，需要填写该参数。
UsedTime String 否 1

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

  • 当Period为Month时，取值为1~9。
  • 当Period为Year时，取值为1~3。
说明 -仅当PayType为Prepaid时，需要填写该参数。
ClientToken String 否 0c593ea1-3bea-11e9-b96b-88888888****

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

InstanceNetworkType String 否 VPC

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

说明 如果不填，则默认为VPC类型。
VPCId String 否 vpc-bp19ame5m1r3oejns****

VPC ID。

说明
  • 公共云仅支持VPC网络，VPCId必填。
  • VPCId所在地域必须与RegionId保持一致。
VSwitchId String 否 vsw-bp1cpq8mr64paltkb****

vSwitch ID。

说明
  • 公共云仅支持VPC网络，VSwitchId必填。
  • VSwitchId所在可用区必须与ZoneId保持一致。
PrivateIpAddress String 否 10.10.XX.XX

实例在vSwitch中的IP地址。
EncryptionKey String 否 0d2470df-da7b-4786-b981-88888888****

密钥ID。

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

加密类型。取值如下：

  • NULL：不启用加密（默认值）。
  • CloudDisk：云盘加密并通过EncryptionKey参数指定密钥。
重要 当前云盘加密开启后无法关闭。
MasterNodeNum Integer 否 1

Master节点数量，取值为1~2。
SrcDbInstanceName String 否 gp-bp12ga6v69h86****

克隆源实例ID。

说明 您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。
BackupId String 否 1111111111

备份集ID。

说明 您可以调用DescribeLogBackups接口查看目标实例的备份信息，包括备份集ID。
DBInstanceCategory String 否 HighAvailability

AnalyticDB PostgreSQL版的实例系列。取值如下：

  • Basic：基础版
  • HighAvailability：高可用版
说明 如果不填，则默认为高可用版。
ResourceGroupId String 否 rg-bp67acfmxazb4p****

实例所在的企业资源组ID。
Tag.N.Key String 否 TestKey

标签键。限制如下：

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

标签值。说明如下：

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

返回数据

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

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

实例ID。
Port String 5432

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

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

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

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

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

OrderId String 111111111111

订单编号。

示例

请求示例

http(s)://gpdb.aliyuncs.com/?Action=CreateECSDBInstance
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-h
&EngineVersion=6.0
&Engine=gpdb
&InstanceSpec=2C16G
&SegNodeNum=4
&SegStorageType=cloud_essd
&StorageSize=200
&DBInstanceDescription=测试用
&SecurityIPList=127.0.0.1
&PayType=Prepaid
&Period=Month
&UsedTime=1
&ClientToken=0c593ea1-3bea-11e9-b96b-88888888****
&InstanceNetworkType=VPC
&VPCId=vpc-bp19ame5m1r3oejns****
&VSwitchId=vsw-bp1cpq8mr64paltkb****
&PrivateIpAddress=10.10.XX.XX
&EncryptionKey=0d2470df-da7b-4786-b981-88888888****
&EncryptionType=CloudDisk
&MasterNodeNum=1
&SrcDbInstanceName=gp-bp12ga6v69h86****
&BackupId=1111111111
&DBInstanceCategory=HighAvailability
&公共请求参数

正常返回示例

XML格式 

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

<CreateECSDBInstanceResponse>
    <RequestId>5414A4E5-4C36-4461-95FC-************</RequestId>
    <DBInstanceId>gp-bp12ga6v69h86****</DBInstanceId>
    <Port>5432</Port>
    <ConnectionString>gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com</ConnectionString>
    <OrderId>111111111111</OrderId>
</CreateECSDBInstanceResponse>

JSON格式 

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

{
  "RequestId" : "5414A4E5-4C36-4461-95FC-************",
  "DBInstanceId" : "gp-bp12ga6v69h86****",
  "Port" : "5432",
  "ConnectionString" : "gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com",
  "OrderId" : "111111111111"
}

错误码

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