創建AnalyticDB PostgreSQL版實例。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
gpdb:CreateDBInstance | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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~8000 。 說明
創建存儲彈性模式實例必須傳入該參數。
| 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 入參發生變更 | 查看變更詳情 |