AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

CreateDBInstance - 创建实例

更新时间：
复制为 MD 格式
我的收藏

创建AnalyticDB PostgreSQL版实例。

接口说明

请确保在使用该接口前，已充分了解 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/*
  • gpdb:EncryptionType
  • gpdb:SSLEnabled
 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

地域 ID。

说明

您可以调用 DescribeRegions 接口查看可用的地域 ID。

cn-hangzhou
ZoneId

string

是

可用区 ID。

说明

您可以调用 DescribeRegions 接口查看可用的可用区 ID。

cn-hangzhou-i
EngineVersion

string

是

引擎版本，取值如下：

  • 6.0：6.0 版。

  • 7.0：7.0 版。

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

否

计费类型，取值如下：

  • Postpaid：按量付费

  • Prepaid：包年包月

说明

  • 如果不填，则会默认为按量付费。

  • 包年包月计费模式下，一次性购买一年及以上时长时会有一定优惠，建议您按需选择计费类型。

Prepaid
Period

string

否

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

  • Month：月

  • Year：年

说明

创建包年包月计费类型的实例时必须传入该参数。

Month
UsedTime

string

否

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

  • 当 Period 为 Month 时，取值为 1~9。

  • 当 Period 为 Year 时，取值为 1~3。

说明

创建包年包月计费类型的实例时必须传入该参数。

1
ClientToken

string

否

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

0c593ea1-3bea-11e9-b96b-88**********
InstanceNetworkType

string

否

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

说明

  • 公共云仅支持 VPC 网络。

  • 如果不填，则默认为 VPC 类型。

VPC
VPCId

string

否

VPC ID。

说明

  • VPCId 必填。

  • VPC 所在地域必须与 RegionId 保持一致。

vpc-bp19ame5m1r3oejns****
VSwitchId

string

否

vSwitch ID。

说明

  • vSwitchId 必填。

  • vSwitch 所在可用区必须与 ZoneId 保持一致。

vsw-bp1cpq8mr64paltkb****
PrivateIpAddress

string

否

该参数已废弃，无需传入该参数。

null
SegStorageType

string

否

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

说明

创建存储弹性模式实例必须传入该参数。

cloud_essd
SegDiskPerformanceLevel

string

否

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

  • pl0：PL0 级别。

  • pl1：PL1 级别。

  • pl2：PL2 级别。

说明

  • 仅磁盘存储类型为 ESSD 云盘时，该参数生效。

  • 如果不填，则默认为 PL1 级别。

pl1
InstanceSpec

string

否

计算节点规格。

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

  • 2C16G

  • 4C32G

  • 16C128G

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

  • 2C8G

  • 4C16G：

  • 8C32G：

  • 16C64G

Serverless 模式取值如下：

  • 4C16G

  • 8C32G

说明

创建存储弹性模式实例和 Serverless 模式实例必须传入该参数。

2C16G
SegNodeNum

string

否

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

  • 存储弹性模式高可用版取值范围为 4~512，取值需为 4 的倍数。

  • 存储弹性模式基础版取值范围为 2~512，取值需为 2 的倍数。

  • Serverless 模式取值范围为 2~512，取值需为 2 的倍数。

说明

创建存储弹性模式实例和 Serverless 模式实例必须传入该参数。

4
MasterNodeNum

string

否

该参数已废弃，无需传入该参数。

null
DBInstanceMode

string

是

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

  • StorageElastic：存储弹性模式。

  • Serverless：Serverless 模式。

  • Classic：存储预留模式。

说明

该参数必填。

StorageElastic
StorageType

string

否

该参数已废弃，无需传入该参数。

null
DBInstanceCategory

string

否

实例系列。取值说明：

  • HighAvailability：高可用版。

  • Basic：基础版。

说明

创建存储弹性模式实例必须传入该参数。

HighAvailability
ResourceGroupId

string

否

实例所在的企业资源组 ID。

rg-bp67acfmxazb4p****
StorageSize

integer

否

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

说明

创建存储弹性模式实例必须传入该参数。

200
CreateSampleData

boolean

否

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

  • true：加载样本数据集。

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

说明

如果不填，则默认为不加载样本数据集。

false
Tag

array<object>

否

第 N 个标签。N 的取值范围：1~20。

object

否

第 N 个标签。N 的取值范围：1~20。

Key

string

否

标签键。限制如下：

  • 不允许为空字符串。

  • 最多支持 128 个字符。

  • 不能以aliyun和acs:开头，不能包含http://或者https://。

TestKey
Value

string

否

标签值。限制如下：

  • 可以为空字符串。

  • 最多支持 128 个字符。

  • 不能以acs:开头，不能包含http://或者https://。

TestValue
ServerlessResource

integer

否

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

说明

仅 Serverless 自动调度模式实例需传入该参数。

32
IdleTime

integer

否

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

说明

仅 Serverless 自动调度模式实例需传入该参数。

600
ServerlessMode

string

否

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

  • Manual：手动调度，为默认值。

  • Auto：自动调度。

说明

  • 仅 Serverless 模式实例需传入该参数。

  • 云原生数据仓库 AnalyticDB PostgreSQL 版 Serverless 自动调度模式正在邀测中。如需使用，请您提交工单申请邀测资格。

Auto
EncryptionType

string

否

加密类型，取值说明：

  • NULL：不启用加密（默认值）。

  • CloudDisk：开通云盘加密，并通过 EncryptionKey 参数指定密钥。

说明

当前云盘加密开启后无法关闭。

CloudDisk
EncryptionKey

string

否

密钥 ID。

说明

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

0d2470df-da7b-4786-b981-88888888****
VectorConfigurationStatus

string

否

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

  • enabled：开启向量引擎优化。

  • disabled（默认）：不开启向量引擎优化。

说明

  • 对于主流分析场景、数仓场景、实时数仓等场景，建议不开启向量引擎优化。

  • 对于使用向量分析引擎用于 AIGC、向量检索等场景用户，建议开启向量引擎优化。

enabled
MasterCU

integer

否

Master 资源，取值如下：

  • 2 CU

  • 4 CU

  • 8 CU

  • 16 CU

  • 32 CU

说明

8CU 以上的 master 资源会产生费用。

8 CU
SrcDbInstanceName

string

否

克隆源实例 ID。

说明

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

gp-bp***************
BackupId

string

否

备份集 ID。

说明

您可以调用 DescribeDataBackups 查看目标实例下所有备份集的备份集 ID。

1111111111
EnableSSL

boolean

否

是否开启 SSL 加密。取值说明：

  • true：开启 SSL 加密。

  • false（默认）：不开 SSL 加密。

false
ProdType

string

否

产品类型。取值说明：

  • standard：标准版。

  • cost-effective：经济版。

说明

如果不填，则会默认为标准版。

standard
DeployMode

string

否

部署模式。取值说明：

  • multiple：多可用区部署。

  • single：单可用区部署。

说明

  • 如果不填，则会默认为单可用区部署。

  • 当前仅支持单可用区部署。

single
StandbyZoneId

string

否

备可用区 ID。

说明

  • 仅多可用区部署时需传入该参数。

  • 您可以调用 DescribeRegions 接口查看可用的可用区 ID。

  • 备可用区 ID 必须与主可用区 ID 不一致。

cn-hangzhou-j
StandbyVSwitchId

string

否

备可用区 VSwitch ID。

说明

  • 仅多可用区部署时需传入该参数。

  • 备可用区 VSwitch ID 所在可用区必须与 StandbyZoneId 保持一致。

vsw-bp1cpq8mr64paltkb****
MasterAISpec

string

否

如果您需要将 Master 节点变更为 MasterAI 节点，请指定该参数。

说明

  • 该参数与 MasterCU 不能同时指定。

  • 仅部分地域和可用区均支持将 Master 节点变更为 MasterAI 节点。

  • 仅 AnalyticDB PostgreSQL 7.0 版的基础版实例支持 MasterAI 节点。

  • 您可以在 Master 节点变配的售卖页面上查询该参数的所有可能取值。

ADB.AIMedium.2
AINodeSpecInfos

array<object>

否

AI 节点规格信息。

object

否

AI 节点规格信息。

AINodeNum

string

否

AI 节点数量。

1
AINodeSpec

string

否

AI 节点规格。

ADB.AIMedium.2
CacheStorageSize

string

否

Serverless 缓存空间，单位为 GB。

800

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

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

5414A4E5-4C36-4461-95FC-************
DBInstanceId

string

实例 ID。

gp-bp12ga6v69h86****
Port

string

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

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

3432
ConnectionString

string

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

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

gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com
OrderId

string

订单编号。

111111111111

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：创建实例下一篇：实例管理