全部產品
Search
文件中心

AnalyticDB:CreateDBInstance

更新時間:Aug 02, 2026

建立 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 模式。

  • ServerlessPro:Serverless Pro 模式。

  • Classic:儲存預留模式。

說明

該參數必填。

StorageElastic

StorageType

string

否

該參數已廢棄,無需傳入該參數。

null

DBInstanceCategory

string

否

執行個體系列。取值說明:

  • HighAvailability:高可用版。

  • Basic:基礎版。

說明

建立儲存彈性模式執行個體必須傳入該參數。

HighAvailability

ResourceGroupId

string

否

執行個體所在的企業資源群組 ID。

rg-bp67acfmxazb4p****

StorageSize

integer

否

儲存空間大小,單位 GB,取值範圍為 50~6000 。

說明

建立儲存彈性模式執行個體必須傳入該參數。

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

否

運算資源閾值。取值範圍 16~1024,步長為 8,單位為 ACU。

說明

僅 Serverless 自動排程模式執行個體需傳入該參數。

16

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 快取空間,取值範圍 800~102400,步長 32G,單位為 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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。