Creates an AnalyticDB for PostgreSQL instance in elastic storage mode.

Description

This operation is called when you need to create AnalyticDB for PostgreSQL instances to meet the requirements of new applications or new services.

Before you call this operation, make sure that you are familiar with the billing methods and pricing of AnalyticDB for PostgreSQL instances. For more information, see Billing methods and AnalyticDB for PostgreSQL pricing.

Limit

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateECSDBInstance

The operation that you want to perform. Set the value to CreateECSDBInstance.

RegionId String Yes cn-hangzhou

The ID of the region in which to create the instance.

Note You can call the DescribeRegions operation to query available regions.
ZoneId String Yes cn-hangzhou-h

The ID of the zone in which to create the instance.

Note You can call the DescribeRegions operation to query available zones.
EngineVersion String Yes 6.0

The version of the database engine. Set the value to 6.0.

Engine String Yes gpdb

The engine of the database. Set the value to gpdb.

InstanceSpec String Yes 2C16G

The compute node specifications.

Valid values for High-availability Edition:

  • 2C16G
  • 4C32G
  • 16C128G

Valid values for Basic Edition:

  • 2C8G
  • 4C16G
  • 8C32G
  • 16C64G
Note If you set this parameter to a value for Basic Edition, you must set DBInstanceCategory to Basic.
SegNodeNum Integer Yes 4

The number of compute nodes.

  • Valid values for High-availability Edition: 4 to 512.
  • Valid values for Basic Edition: 2 to 512.
SegStorageType String Yes cloud_essd

The storage type of the disk.

Valid values for High-availability Edition:

  • cloud_essd: enhanced SSD (ESSD)
  • cloud_efficiency: ultra disk

Valid values for Basic Edition:

  • cloud_essd: ESSD
StorageSize Integer Yes 200

The storage capacity. Unit: GB. Valid values: 50 to 4000.

DBInstanceDescription String No Instance in Alibaba Cloud test environment

The description of the instance.

SecurityIPList String No 127.0.0.1

The IP address whitelist of the instance. Default value: 127.0.0.1.

PayType String No Prepaid

The billing method of the instance. Valid values:

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
Note
  • If you do not set this parameter, it is set to Postpaid by default.
  • The subscription fees are lower if your subscription period is one year or more. We recommend that you select the billing method that best suits your needs.
Period String No Month

The unit of the subscription period. Valid values:

  • Month
  • Year
Note This parameter is required only when you set PayType to Prepaid.
UsedTime String No 1

The subscription period. Valid values:

  • 1 to 9: if Period is set to Month.
  • 1 to 3: if Period is set to Year.
Note This parameter is required only when you set PayType to Prepaid.
ClientToken String No 0c593ea1-3bea-11e9-b96b-88**********

The client token that is used to ensure the idempotence of the request. For more information, see How to ensure idempotence.

InstanceNetworkType String No VPC

The network type of the instance. Set the value to VPC.

Note If you do not set this parameter, it is set to VPC by default.
VPCId String No vpc-xxxxxxxxxx

The virtual private cloud (VPC) ID of the instance.

Note
  • You must specify the VPCId parameter because only the VPC network type is supported.
  • The region where the VPCID resides must be the same as the RegionId value.
VSwitchId String No vsw-xxxxxxxxx

The vSwitch ID of the instance.

Note
  • You must specify the VSwitchId parameter because only the VPC network type is supported.
  • The zone where the VSwitchID resides must be the same as the ZoneId value.
EncryptionKey String No 0d2470df-da7b-4786-b981-************

The ID of the encryption key.

Note If the EncryptionType parameter is set to CloudDisk, you must specify this parameter to the encryption key that is in the same region as the disk that is specified by the EncryptionType parameter. Otherwise, leave this parameter empty.
EncryptionType String No CloudDisk

The type of the encryption. Valid values:

  • Default value: NULL. Encryption is disabled.
  • CloudDisk: Encryption is enabled on disks and the encryption key is specified by using the EncryptionKey parameter.
Notice Disk encryption cannot be disabled after it is enabled.
MasterNodeNum Integer No 1

The number of coordinator nodes. Valid values: 1 and 2.

SrcDbInstanceName String No gp-bp***************

The ID of the source instance.

Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances within a specific region, including instance IDs.
BackupId String No 1111111111

The ID of the backup set.

Note You can call the DescribeLogBackups operation to query the backup details of an instance, including the IDs of backup sets.
DBInstanceCategory String No HighAvailability

The edition of the instance. Valid values:

  • Basic: Basic Edition
  • HighAvailability: High-availability Edition
Note If you do not set this parameter, it is set to HighAvailability by default.

Response parameters

Parameter Type Example Description
RequestId String 5414A4E5-4C36-4461-95FC-************

The ID of the request.

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

The ID of the instance.

Port String 5432

An invalid parameter. It is no longer returned when you call this operation.

You can call the DescribeDBInstanceOnECSAttribute operation to query the port that is used to connect to the instance.

ConnectionString String gp-xxxxxxx.gpdb.rds.aliyuncs.com

An invalid parameter. It is no longer returned when you call this operation.

You can call the DescribeDBInstanceOnECSAttribute operation to query the endpoint that is used to connect to the instance.

OrderId String 111111111111

The order ID of the instance.

Examples

Sample requests

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=Instance in Alibaba Cloud test environment
&SecurityIPList=127.0.0.1
&PayType=Prepaid
&Period=Month
&UsedTime=1
&ClientToken=0c593ea1-3bea-11e9-b96b-88**********
&InstanceNetworkType=VPC
&VPCId=vpc-xxxxxxxxxx
&VSwitchId=vsw-xxxxxxxxx
&EncryptionKey=0d2470df-da7b-4786-b981-************
&EncryptionType=CloudDisk
&MasterNodeNum=1
&SrcDbInstanceName=gp-bp***************
&BackupId=1111111111
&DBInstanceCategory=HighAvailability
&<Common request parameters>

Sample success responses

XML format 

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

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

JSON format 

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

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

Error codes

For a list of error codes, visit the API Error Center.