CreateDBCluster。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| polardb:CreateDBCluster | create | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 說明
您可以通過 DescribeRegions 接口查看可用地域。
| cn-hangzhou |
| ZoneId | string | 否 | 可用區 ID。 說明
您可以通過 DescribeRegions 接口查看可選的可用區。
| cn-hangzhou-j |
| Architecture | string | 否 | CPU 架構。取值范圍如下：
| X86 |
| DBType | string | 是 | 數據庫引擎類型，取值范圍如下：
| MySQL |
| DBVersion | string | 是 | 數據庫引擎版本號。
| 5.6 |
| DBNodeClass | string | 是 | 節點規格，詳情請參見如下文檔： 說明
| polar.mysql.x4.medium |
| ClusterNetworkType | string | 否 | 集群網絡類型，當前僅支持專有網絡，取值固定為 VPC。 | VPC |
| DBClusterDescription | string | 否 | 集群名稱，集群名稱需滿足如下要求：
| test |
| PayType | string | 是 | 付費類型，取值范圍如下：
| Postpaid |
| AutoRenew | boolean | 否 | 是否自動續費，取值范圍如下：
默認為 false。 說明
當參數 PayType 取值為 Prepaid 時，該參數才生效。
| true |
| Period | string | 否 | 若付費類型為 Prepaid 時，該參數為必傳參數。指定預付費集群為包年或包月類型。
| Month |
| UsedTime | string | 否 | 若付費類型為 Prepaid 時，該參數為必傳參數。
| 1 |
| VPCId | string | 否 | 專有網絡 ID。 | vpc-********** |
| VSwitchId | string | 否 | 虛擬交換機 ID。 說明
如果已選擇 VPCId，則 VSwitchId 必選。
| vsw-********** |
| CreationOption | string | 否 | 創建方式，取值范圍如下：
默認為 Normal。 說明
當 DBType 為 MySQL 且 DBVersion 為8.0時，本參數取值可以為 CreateGdnStandby。
| Normal |
| SourceResourceId | string | 否 | 源 RDS 實例 ID 或源 PolarDB 集群 ID。僅當 CreationOption 為 MigrationFromRDS、CloneFromRDS、CloneFromPolarDB 或 RecoverFromRecyclebin 時，該參數必填。
| rm-************* |
| CloneDataPoint | string | 否 | 克隆數據的時間節點，取值：
默認為 LATEST。 說明
若 CreationOption 為 CloneFromRDS，則本參數取值只能為 LATEST。
| LATEST |
| ClientToken | string | 否 | 用于保證請求的冪等性。由客戶端生成該參數值，保證在不同請求間唯一，大小寫敏感、不超過 64 個 ASCII 字符。 | 6000170000591aed949d0f5******************** |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-************ |
| SecurityIPList | string | 否 | PolarDB 集群白名單 IP 地址。 說明
支持配置多個白名單 IP 地址，多個 IP 地址之間使用英文逗號分隔。
| 10.***.***.*** |
| TDEStatus | boolean | 否 | 開啟 TDE 加密。取值范圍如下：
說明
| true |
| GDNId | string | 否 | 全球數據庫網絡 ID。 說明
當 CreationOption 為 CreateGdnStandby 時，本參數必填。
| gdn-*********** |
| CreationCategory | string | 否 | 產品系列，取值范圍如下：
說明
更多關產品系列的介紹，請參見產品系列。 | Normal |
| DefaultTimeZone | string | 否 | 集群時區（UTC），可選取值范圍為**-12:00~+13:00內的所有整點時間，如00:00**。默認取值為 SYSTEM，默認時區與 Region 所在時區一致。 說明
僅當 DBType 為 MySQL 時，該參數生效。
| SYSTEM |
| LowerCaseTableNames | string | 否 | 表名是否區分大小寫，取值范圍如下：
默認取值為 1。 說明
僅當 DBType 為 MySQL 時，該參數生效。
| 1 |
| BackupRetentionPolicyOnClusterDeletion | string | 否 | 刪除集群時備份集保留策略，取值范圍如下：
創建集群時，默認取值為 NONE，即集群刪除時不保留備份集。 說明
| NONE |
| StorageSpace | long | 否 | 按空間計費（包年包月）的存儲空間。單位：GB。 說明
| 50 |
| DBMinorVersion | string | 否 | 數據庫引擎小版本號。取值范圍如下：
說明
當參數 DBType 為 MySQL 且 DBVersion 為8.0時，該參數才生效。
| 8.0.1 |
| ParameterGroupId | string | 否 | 參數模板 ID。 說明
您可以通過 DescribeParameterGroups 接口查看目標地域的參數模板列表，包括參數模板 ID。
| pcpg-************** |
| Tag | array<object> | 否 | 標簽列表。 | |
| object | 否 | |||
| Key | string | 否 | 標簽鍵。若您需要為目標集群一次性添加多個標簽，請單擊添加增加標簽鍵。 說明
每次最多添加 20 對標簽， Tag.N.Key對應的值為Tag.N.Value。
| type |
| Value | string | 否 | 標簽值。若您需要為目標集群一次性添加多個標簽，請單擊添加增加標簽值。 說明
每次最多添加 20 對標簽， Tag.N.Value對應的值為Tag.N.Key。
| test |
| ServerlessType | string | 否 | Serverless 類型。當前取值固定為 AgileServerless（敏態）。 說明
僅 Serverless 集群支持該參數。
| AgileServerless |
| ScaleMin | string | 否 | 單節點伸縮下限。取值范圍：1 PCU~31 PCU。 說明
僅 Serverless 集群支持該參數。
| 1 |
| ScaleMax | string | 否 | 單節點伸縮上限。取值范圍：1 PCU~32 PCU。 說明
僅 Serverless 集群支持該參數。
| 3 |
| AllowShutDown | string | 否 | 是否開啟無活動暫停。取值：
說明
僅 Serverless 集群支持該參數。
| true |
| ScaleRoNumMin | string | 否 | 只讀節點個數伸縮下限。取值范圍：0~15。 說明
僅 Serverless 集群支持該參數。
| 2 |
| ScaleRoNumMax | string | 否 | 只讀節點個數伸縮上限。取值范圍：0~15。 說明
僅 Serverless 集群支持該參數。
| 4 |
| StorageType | string | 否 | 企業版存儲類型取值如下：
標準版存儲類型取值如下：
| PSL4 |
| DBNodeNum | integer | 否 | 標準版和企業版節點個數。取值如下：
說明
| 1 |
| HotStandbyCluster | string | 否 | 是否開啟熱備集群。取值范圍如下：
說明
標準版集群的默認值為 STANDBY。
| ON |
| StrictConsistency | string | 否 | 集群是否開啟了多可用區數據強一致。取值范圍如下：
| ON |
| StandbyAZ | string | 否 | 存儲熱備集群的可用區。適用于標準版 3AZ 場景。 說明
開啟了多可用區數據強一致，該參數才生效。
| cn-hangzhou-g |
| ProxyType | string | 否 | 數據庫代理類型，取值范圍如下：
說明
代理類型需要與集群的節點規格對應的類型保持一致。即：
| Exclusive |
| ProxyClass | string | 否 | 標準版數據庫代理規格。取值如下：
| polar.maxscale.g2.medium.c |
| LoosePolarLogBin | string | 否 | 開啟 Binlog 功能，取值范圍如下：
說明
當參數 DBType 為 MySQL 時，該參數才生效。
| ON |
| LooseXEngine | string | 否 | 開啟 X-Engine 存儲引擎功能，取值范圍如下：
說明
當參數 CreationOption 不等于 CreateGdnStandby，DBType 為 MySQL 且 DBVersion 為8.0時，該參數才生效。開啟 X-Engine 引擎的節點內存規格必須大于等于 8 GB。
| ON |
| LooseXEngineUseMemoryPct | string | 否 | 設置開啟 X-Engine 存儲引擎比例，取值范圍 10~90 的整數。 說明
當參數 LooseXEngine 為 ON 時，該參數才生效。
| 50 |
| StoragePayType | string | 否 | 存儲計費類型。取值范圍如下：
| Prepaid |
| StorageAutoScale | string | 否 | 標準版集群是否開啟存儲自動擴容。取值范圍如下：
| Enable |
| StorageUpperBound | long | 否 | 設置標準版集群存儲自動擴容上限，單位：GB。 說明
取值最大為 32000。
| 800 |
| ProvisionedIops | long | 否 | ESSD AutoPL 云盤預配置的讀寫 IOPS?？赡苤担?~min{50,000, 1000*容量-基準性能}。 基準性能=min{1,800+50*容量, 50000}。 說明 當 StorageType 為 ESSDAUTOPL 時才支持該參數。 | 1000 |
| BurstingEnabled | string | 否 | ESSD AutoPL 云盤是否開啟 IO 性能突發。取值：
說明
當 StorageType 為 ESSDAUTOPL 時才支持該參數。
| false |
返回參數
示例
正常返回示例
JSON格式
{
"DBClusterId": "pc-bp1s826a1up******",
"OrderId": "211454967******",
"RequestId": "E56531A4-E552-40BA-9C58-137B80******",
"ResourceGroupId": "rg-***************"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidBackupRetentionPolicyOnClusterDeletion.Malformed | The specified BackupRetentionPolicyOnClusterDeletion is invalid. | 當前刪除（釋放）集群時的保留備份策略（ BackupRetentionPolicyOnClusterDeletion）無效。 |
| 400 | InvalidLowerCaseTableNames.Malformed | The specified LowerCaseTableNames is invalid. | 指定的表名是否區分大小寫參數（LowerCaseTableNames）無效。 |
| 400 | InvalidDefaultTimeZone.Malformed | The specified DefaultTimeZone is invalid. | 指定的默認時區參數（DefaultTimeZone）無效。 |
| 400 | Location.FailedGetSubDomain | The specified regionId does not match the zoneId or the zoneId does not exist. | 指定的地域ID與可用區ID不匹配或者可用區ID不存在。 |
| 400 | InvalidLowerCaseTableNames.Malformed | The specified LowerCaseTableNames value is invalid. | 指定的小寫字母名稱無效。 |
| 400 | MissParameter.GDNId | The GDNId parameter is required. | 需要指定的GDNId。 |
| 400 | EntityNotExist.ResourceGroup | The resource group does not exist.. | 資源組不存在 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-11-16 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-10-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-08-03 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-08-01 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-06-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-05-25 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-04-19 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-03-14 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2022-11-16 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-11-02 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |