调用CreateDBInstance接口创建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 | 引擎版本,取值如下:
|
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 | 计费类型,取值如下:
说明
|
Period | String | 否 | Month | 购买资源的时长单位。取值如下:
说明 创建包年包月计费类型的实例时必须传入该参数。 |
UsedTime | String | 否 | 1 | 购买资源的时长。取值如下:
说明 创建包年包月计费类型的实例时必须传入该参数。 |
ClientToken | String | 否 | 0c593ea1-3bea-11e9-b96b-88********** | 幂等性校验。更多信息,请参见如何保证幂等性。 |
InstanceNetworkType | String | 否 | VPC | 实例网络类型,取值为VPC。 说明
|
VPCId | String | 否 | vpc-bp19ame5m1r3oejns**** | VPC ID。 说明
|
VSwitchId | String | 否 | vsw-bp1cpq8mr64paltkb**** | vSwitch ID。 说明
|
PrivateIpAddress | String | 否 | 1.1.1.* | 私有IP地址。 |
SegStorageType | String | 否 | cloud_essd | 磁盘存储类型,目前仅支持ESSD云盘,取值为:cloud_essd。 说明 创建存储弹性模式实例必须传入该参数。 |
SegDiskPerformanceLevel | String | 否 | pl1 | ESSD云盘的性能级别,取值如下:
说明
|
InstanceSpec | String | 否 | 2C16G | 计算节点规格。 存储弹性模式高可用版取值如下:
存储弹性模式基础版取值如下:
Serverless模式取值如下:
说明 创建存储弹性模式实例和Serverless模式实例必须传入该参数。 |
SegNodeNum | String | 否 | 4 | 计算节点个数,取值说明:
说明 创建存储弹性模式实例和Serverless模式实例必须传入该参数。 |
MasterNodeNum | String | 否 | 1 | Master节点数量,取值为1~2。 说明 如果不填,则默认为1个Master节点。 |
DBInstanceMode | String | 否 | StorageElastic | 实例资源类型,取值说明:
说明 该参数必填。 |
StorageType | String | 否 | null | 该参数已废弃,无需传入该参数。 |
DBInstanceCategory | String | 否 | HighAvailability | 实例系列。取值说明:
说明 创建存储弹性模式实例必须传入该参数。 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** | 实例所在的企业资源组ID。 |
StorageSize | Long | 否 | 200 | 存储空间大小,单位GB,取值范围为50~4000。 说明 创建存储弹性模式实例必须传入该参数。 |
CreateSampleData | Boolean | 否 | false | 是否在实例创建完成后,加载样本数据集,取值如下:
如果不填,则默认为不加载样本数据集。 |
Tag.N.Key | String | 否 | TestKey | 标签键。限制如下:
|
Tag.N.Value | String | 否 | TestValue | 标签值。限制如下:
|
ServerlessResource | Integer | 否 | 32 | 计算资源阈值。取值范围8~32,步长为8,单位为ACU。默认值为32。 说明 仅Serverless自动调度模式实例需传入该参数。 |
IdleTime | Integer | 否 | 600 | 空闲释放等待时长。即当无业务流量的时长达到指定时长后,实例转为空闲状态。单位为秒,最小值为60,默认值为600。 说明 仅Serverless自动调度模式实例需传入该参数。 |
ServerlessMode | String | 否 | Auto | Serverless实例的模式,取值如下:
说明 仅Serverless模式实例需传入该参数。 |
EncryptionType | String | 否 | CloudDisk | 加密类型,取值说明:
说明 当前云盘加密开启后无法关闭。 |
EncryptionKey | String | 否 | 0d2470df-da7b-4786-b981-88888888**** | 密钥ID。 说明 如果参数EncryptionType的值为CloudDisk则需要通过该参数指定同地域内的加密密钥ID,否则为空。 |
VectorConfigurationStatus | String | 否 | enabled | 是否开启向量引擎优化。取值说明:
说明
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
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"
}
错误码
访问错误中心查看更多错误码。