创建AnalyticDB PostgreSQL版实例。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
gpdb:CreateDBInstance | create | *DBInstance acs:gpdb:{#regionId}:{#accountId}:dbinstance/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 说明
您可以调用 DescribeRegions 接口查看可用的地域 ID。
| cn-hangzhou |
ZoneId | string | 是 | 可用区 ID。 说明
您可以调用 DescribeRegions 接口查看可用的可用区 ID。
| cn-hangzhou-i |
EngineVersion | string | 是 | 引擎版本,取值如下:
| 6.0 |
Engine | string | 是 | 数据库引擎,取值为 gpdb。 | gpdb |
DBInstanceClass | string | 否 | 实例规格,详细说明请参见 DBInstanceClass 参数补充说明。 说明
创建存储预留模式实例必须传入该参数。
| gpdb.group.segsdx1 |
DBInstanceGroupCount | string | 否 | 计算组数量。取值为:2、4、8、12、16、24、32、64、96、128。 说明
创建存储预留模式实例必须传入该参数。
| 2 |
DBInstanceDescription | string | 否 | 实例描述。 | test |
SecurityIPList | string | 否 | IP 白名单。 127.0.0.1 表示禁止任何外部 IP 访问,您可以在实例创建完成后调用 ModifySecurityIps 接口修改 IP 白名单。 | 127.0.0.1 |
PayType | string | 否 | 计费类型,取值如下:
说明
| Prepaid |
Period | string | 否 | 购买资源的时长单位。取值如下:
说明
创建包年包月计费类型的实例时必须传入该参数。
| Month |
UsedTime | string | 否 | 购买资源的时长。取值如下:
说明
创建包年包月计费类型的实例时必须传入该参数。
| 1 |
ClientToken | string | 否 | 幂等性校验。更多信息,请参见如何保证幂等性。 | 0c593ea1-3bea-11e9-b96b-88********** |
InstanceNetworkType | string | 否 | 实例网络类型,取值为 VPC。 说明
| VPC |
VPCId | string | 否 | VPC ID。 说明
| vpc-bp19ame5m1r3oejns**** |
VSwitchId | string | 否 | vSwitch ID。 说明
| vsw-bp1cpq8mr64paltkb**** |
PrivateIpAddress | string | 否 | 该参数已废弃,无需传入该参数。 | null |
SegStorageType | string | 否 | 磁盘存储类型,目前仅支持 ESSD 云盘,取值为:cloud_essd。 说明
创建存储弹性模式实例必须传入该参数。
| cloud_essd |
SegDiskPerformanceLevel | string | 否 | ESSD 云盘的性能级别,取值如下:
说明
| pl1 |
InstanceSpec | string | 否 | 计算节点规格。 存储弹性模式高可用版取值如下:
存储弹性模式基础版取值如下:
Serverless 模式取值如下:
说明
创建存储弹性模式实例和 Serverless 模式实例必须传入该参数。
| 2C16G |
SegNodeNum | string | 否 | 计算节点个数,取值说明:
说明
创建存储弹性模式实例和 Serverless 模式实例必须传入该参数。
| 4 |
MasterNodeNum | string | 否 | 该参数已废弃,无需传入该参数。 | null |
DBInstanceMode | string | 是 | 实例资源类型,取值说明:
说明
该参数必填。
| StorageElastic |
StorageType | string | 否 | 该参数已废弃,无需传入该参数。 | null |
DBInstanceCategory | string | 否 | 实例系列。取值说明:
说明
创建存储弹性模式实例必须传入该参数。
| HighAvailability |
ResourceGroupId | string | 否 | 实例所在的企业资源组 ID。 | rg-bp67acfmxazb4p**** |
StorageSize | long | 否 | 存储空间大小,单位 GB,取值范围为 50~6000 。 说明
创建存储弹性模式实例必须传入该参数。
| 200 |
CreateSampleData | boolean | 否 | 是否在实例创建完成后,加载样本数据集,取值如下:
说明
如果不填,则默认为不加载样本数据集。
| false |
Tag | array<object> | 否 | 第 N 个标签。N 的取值范围:1~20。 | |
object | 否 | 第 N 个标签。N 的取值范围:1~20。 | ||
Key | string | 否 | 标签键。限制如下:
| TestKey |
Value | string | 否 | 标签值。限制如下:
| TestValue |
ServerlessResource | integer | 否 | 计算资源阈值。取值范围 8~32,步长为 8,单位为 ACU。默认值为 32。 说明
仅 Serverless 自动调度模式实例需传入该参数。
| 32 |
IdleTime | integer | 否 | 空闲释放等待时长。即当无业务流量的时长达到指定时长后,实例转为空闲状态。单位为秒,最小值为 60,默认值为 600。 说明
仅 Serverless 自动调度模式实例需传入该参数。
| 600 |
ServerlessMode | string | 否 | Serverless 实例的模式,取值如下:
说明
仅 Serverless 模式实例需传入该参数。
| Auto |
EncryptionType | string | 否 | 加密类型,取值说明:
说明
当前云盘加密开启后无法关闭。
| CloudDisk |
EncryptionKey | string | 否 | 密钥 ID。 说明
如果参数 EncryptionType 的值为 CloudDisk 则需要通过该参数指定同地域内的加密密钥 ID,否则为空。
| 0d2470df-da7b-4786-b981-88888888**** |
VectorConfigurationStatus | string | 否 | 是否开启向量引擎优化。取值说明:
说明
| enabled |
MasterCU | integer | 否 | Master 资源,取值如下:
说明
8CU 以上的 master 资源会产生费用。
| 8 CU |
SrcDbInstanceName | string | 否 | 克隆源实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
| gp-bp*************** |
BackupId | string | 否 | 备份集 ID。 说明
您可以调用 DescribeDataBackups 查看目标实例下所有备份集的备份集 ID。
| 1111111111 |
EnableSSL | boolean | 否 | 是否开启 SSL 加密。取值说明:
| false |
ProdType | string | 否 | 产品类型。取值说明:
说明
如果不填,则会默认为标准版。
| standard |
DeployMode | string | 否 | 部署模式。取值说明:
说明
| single |
StandbyZoneId | string | 否 | 备可用区 ID。 说明
| cn-hangzhou-j |
StandbyVSwitchId | string | 否 | 备可用区 VSwitch ID。 说明
| vsw-bp1cpq8mr64paltkb**** |
DBInstanceClass 参数补充说明
目前,AnalyticDB for PostgreSQL 支持如下两种实例规格:
- 高性能:规格名称以 gpdb.group.segsdx 开始,特点是可以提供更好的 I/O 能力,带来更高的性能。
- 高容量:规格名称以 gpdb.group.seghdx 开始,特点是可以提供更大、更实惠的空间,满足更高的存储需求。
因此,在选择实例规格时,建议您根据需要的存储空间和计算能力进行选择。
同时,AnalyticDB for PostgreSQL 支持基于 OSS 的外部表扩展,并可通过 gzip 实现外部存储上的数据压缩,不需要参与实时计算的数据可以存放到外部存储以进一步节省存储成本。
高性能实例的规格信息如下表所示:
【高性能】规格 | CPU | 内存 | 存储空间 |
gpdb.group.segsdx1 | 1 Core | 8 GB | 80 GB SSD |
gpdb.group.segsdx2 | 2 Cores | 16 GB | 160 GB SSD |
gpdb.group.segsdx16 | 16 Cores | 128 GB | 1.28 TB SSD |
高容量型实例的规格信息如下表所示:
【高容量】规格 | CPU | 内存 | 存储空间 |
gpdb.group.seghdx4 | 4 Cores | 32 GB | 2 TB HDD |
gpdb.group.seghdx36 | 36 Cores | 288 GB | 18 TB HDD |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "5414A4E5-4C36-4461-95FC-************",
"DBInstanceId": "gp-bp12ga6v69h86****",
"Port": "3432",
"ConnectionString": "gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com",
"OrderId": "111111111111"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-10-11 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-13 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-01-04 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-18 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-09-18 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-08-17 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-08-17 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-23 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-04 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-18 | OpenAPI 入参发生变更 | 查看变更详情 |