全部產品
Search

搜尋本產品

    PolarDB：CreateDBCluster

    文件中心

    PolarDB：CreateDBCluster

    更新時間：Jul 01, 2026

    CreateDBCluster。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:CreateDBCluster

    create

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}
    • polardb:EncryptionRequired
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    地域 ID。

    說明

    您可以透過 DescribeRegions 介面查看可用地域。

    cn-hangzhou
    ZoneId

    string

    否

    可用區 ID。

    說明

    您可以透過 DescribeRegions 介面查看可選的可用區。

    cn-hangzhou-j
    Architecture

    string

    否

    CPU 架構。取值範圍如下：

    • X86

    • ARM

    X86
    DBType

    string

    是

    資料庫引擎類型，取值範圍如下：

    • MySQL

    • PostgreSQL

    • Oracle

    MySQL
    DBVersion

    string

    是

    資料庫引擎版本號。

    • MySQL 版本號取值範圍如下：

      • 5.6

      • 5.7

      • 8.0

    • PostgreSQL 版本號取值範圍如下：

      • 11

      • 14

      • 15

    說明

    PolarDB PostgreSQL 版中如需建立 Serverless 叢集，版本號只支援 14。

    * Oracle 版本號取值範圍如下： * **11** * **14**

    5.6
    DBNodeClass

    string

    否

    節點規格，詳情請參見如下文件：

    說明

    • PolarDB MySQL 叢集版如需建立 Serverless 叢集，請傳入polar.mysql.sl.small。

    • PolarDB MySQL 標準版如需建立 Serverless 叢集，請傳入polar.mysql.sl.small.c。

    • PolarDB PostgreSQL 叢集版如需建立 Serverless 叢集，請傳入polar.pg.sl.small。

    • PolarDB PostgreSQL 標準版如需建立 Serverless 叢集，請傳入polar.pg.sl.small.c。

    • PolarDB PostgreSQL 版（相容 Oracle）如需建立 Serverless 叢集，請傳入polar.o.sl.small。

    polar.mysql.x4.medium
    ClusterNetworkType

    string

    否

    叢集網路類型，當前僅支援專有網路，取值固定為 VPC。

    VPC
    DBClusterDescription

    string

    否

    叢集名稱，叢集名稱需滿足如下要求：

    • 不能以http://或https://開頭。

    • 長度為 2~256 個字元。

    test
    PayType

    string

    是

    付費類型，取值範圍如下：

    • Postpaid：按量付費。

    • Prepaid：預付費（包年包月）。

    Postpaid
    AutoRenew

    boolean

    否

    是否自動續費，取值範圍如下：

    • true：自動續費。

    • false：不自動續費。

    預設為 false。

    說明

    當參數 PayType 取值為 Prepaid 時，該參數才生效。

    true
    Period

    string

    否

    若付費類型為 Prepaid 時，該參數為必傳參數。指定預付費叢集為包年或包月類型。

    • Year：包年。即選擇包年包月時，單位為年。

    • Month：包月。即選擇包年包月時，單位為月。

    Month
    UsedTime

    string

    否

    若付費類型為 Prepaid 時，該參數為必傳參數。

    • 當 Period 為 Month 時，UsedTime 取值為整數類型，取值範圍為[1-9]。

    • 當 Period 為 Year 時，UsedTime 取值為整數類型，取值範圍為[1-3]。

    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 時，該參數必填。

    • 若 CreationOption 為 MigrationFromRDS 或 CloneFromRDS，您需要為本參數傳入來源 RDS 執行個體 ID。來源 RDS 執行個體版本需為 RDS MySQL 5.6 、5.7 或 8.0 高可用版。

    • 若 CreationOption 為 CloneFromPolarDB，您需要為本參數傳入來源 PolarDB 叢集 ID。克隆叢集和來源叢集的 DBType 預設保持一致。例如來源叢集為 MySQL 8.0，則克隆叢集也需設定 DBType 為 MySQL 且 DBVersion 為8.0。

    • 若 CreationOption 為 RecoverFromRecyclebin，您需要為本參數傳入已釋放的來源 PolarDB 叢集 ID。從資源回收筒恢復的叢集和來源叢集的 DBType 需保持一致。例如來源叢集為 MySQL 8.0，則從資源回收筒恢復的叢集也需設定 DBType 為 MySQL 且 DBVersion 為8.0。

    rm-*************
    CloneDataPoint

    string

    否

    克隆資料的時間節點，取值：

    • LATEST：最新時間點的資料。

    • BackupID：歷史備份集 ID，請傳入具體的備份集 ID。

    • Timestamp：歷史時間點，請傳入具體的時間，格式：YYYY-MM-DDThh:mm:ssZ（UTC 時間）。

    預設為 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：開啟。

    • false：關閉（預設值）。

    說明

    • 僅當 DBType 為 PostgreSQL 或 Oracle 時，本參數生效。

    • 您可以呼叫 ModifyDBClusterTDE 介面為 PolarDB MySQL 叢集開啟 TDE 加密。

    • TDE 功能開啟後不可關閉。

    true
    GDNId

    string

    否

    全球資料庫網路 ID。

    說明

    當 CreationOption 為 CreateGdnStandby 時，本參數必填。

    gdn-***********
    CreationCategory

    string

    否

    產品系列，取值範圍如下：

    • Normal：叢集版（預設值）

    • Basic：單節點

    • ArchiveNormal：高壓縮引擎（X-Engine）

    • NormalMultimaster：多主架構叢集版

    • SENormal：標準版

    說明

    • MySQL 5.6、5.7、8.0，PostgreSQL 14 以及 Oracle 語法相容 2.0 版支援 Basic。

    • MySQL 8.0支援 ArchiveNormal 和 NormalMultimaster。

    • MySQL 5.6、5.7、8.0和 PostgreSQL 14 支援 SENormal。

    更多關於產品系列的介紹，請參見產品系列。

    Normal
    DefaultTimeZone

    string

    否

    叢集時區（UTC），可選取值範圍為**-12:00~+13:00內的所有整點時間，如00:00**。預設取值為 SYSTEM，預設時區與 Region 所在時區一致。

    說明

    僅當 DBType 為 MySQL 時，該參數生效。

    SYSTEM
    LowerCaseTableNames

    string

    否

    表名是否區分大小寫，取值範圍如下：

    • 1：不區分大小寫

    • 0：區分大小寫

    預設取值為 1。

    說明

    僅當 DBType 為 MySQL 時，該參數生效。

    1
    BackupRetentionPolicyOnClusterDeletion

    string

    否

    刪除叢集時備份集保留策略，取值範圍如下：

    • ALL：長期保留全部備份。

    • LATEST：長期保留最後一個備份（刪除前自動備份）。

    • NONE：叢集刪除時不保留備份集。

    建立叢集時，預設取值為 NONE，即叢集刪除時不保留備份集。

    說明

    • 僅當 DBType 為 MySQL 時，該參數生效。

    • Serverless 叢集不支援該參數。

    NONE
    StorageSpace

    integer

    否

    按空間計費（包年包月）的儲存空間。單位：GB。

    說明

    • PolarDB MySQL 企業版儲存空間的取值範圍：10~50000。

    • PolarDB MySQL 標準版儲存空間的取值範圍：20~64000。

    • 標準版儲存類型為 ESSDAUTOPL 時，儲存空間的取值範圍：40~64000，步長最小為 10，即只能填寫 40、50、60...以此類推。

    50
    DBMinorVersion

    string

    否

    資料庫引擎小版本號。取值範圍如下：

    • 8.0.2

    • 8.0.1

    說明

    當參數 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

    否

    是否開啟無活動暫停。取值：

    • true：開啟

    • false：關閉（預設）

    說明

    僅 Serverless 叢集支援該參數。

    true
    ScaleRoNumMin

    string

    否

    唯讀節點個數伸縮下限。取值範圍：0~15。

    說明

    僅 Serverless 叢集支援該參數。

    2
    ScaleRoNumMax

    string

    否

    唯讀節點個數伸縮上限。取值範圍：0~15。

    說明

    僅 Serverless 叢集支援該參數。

    4
    StorageType

    string

    否

    企業版儲存類型取值如下：

    • PSL5

    • PSL4

    標準版儲存類型取值如下：

    • ESSDPL0

    • ESSDPL1

    • ESSDPL2

    • ESSDPL3

    • ESSDAUTOPL

    PSL4
    DBNodeNum

    integer

    否

    標準版和企業版節點個數。取值如下：

    • 標準版取值範圍：1~8（支援 1 個讀寫節點和 7 個唯讀節點）。

    • 企業版取值範圍：1~16（支援 1 個讀寫節點和 15 個唯讀節點）。

    說明

    • 企業版預設有 2 個節點，標準版預設有 1 個節點。

    • 僅 PolarDB MySQL 版支援該參數。

    • 目前暫不支援多主叢集節點數量變更設定。

    1
    HotStandbyCluster

    string

    否

    是否開啟熱備叢集。取值範圍如下：

    • ON（預設）：開啟儲存熱備叢集。

    • OFF：關閉熱備叢集。

    • STANDBY：開啟熱備叢集。

    • EQUAL：開啟儲存熱備和計算熱備。

    • 3AZ：多可用區資料強一致。

    說明

    STANDBY 僅對 PolarDB PostgreSQL 版生效。

    ON
    StrictConsistency

    string

    否

    叢集是否開啟了多可用區資料強一致。取值範圍如下：

    • ON：表示開啟了多可用區資料強一致，適用於標準版 3AZ 場景。

    • OFF：表示未開啟多可用區資料強一致。

    ON
    StandbyAZ

    string

    否

    熱備叢集的可用區。

    說明

    開啟了熱備叢集或多可用區資料強一致，該參數才生效。

    cn-hangzhou-g
    ProxyType

    string

    否

    資料庫代理類型，取值範圍如下：

    • EXCLUSIVE：企業獨享版

    • GENERAL：企業通用版

    說明

    代理類型需要與叢集的節點規格對應的類型保持一致。即：

    • 節點規格為通用規格，則代理類型應為企業通用版；

    • 節點規格為獨享規格，則代理類型應為企業獨享版。

    Exclusive
    ProxyClass

    string

    否

    標準版資料庫代理規格。取值如下：

    • polar.maxscale.g2.medium.c：2 核。

    • polar.maxscale.g2.large.c：4 核。

    • polar.maxscale.g2.xlarge.c：8 核。

    • polar.maxscale.g2.2xlarge.c：16 核。

    • polar.maxscale.g2.3xlarge.c：24 核。

    • polar.maxscale.g2.4xlarge.c：32 核。

    • polar.maxscale.g2.8xlarge.c：64 核。

    polar.maxscale.g2.medium.c
    LoosePolarLogBin

    string

    否

    開啟 Binlog 功能，取值範圍如下：

    • ON：叢集開啟 Binlog 功能。

    • OFF：叢集關閉 Binlog 功能。

    說明

    當參數 DBType 為 MySQL 時，該參數才生效。

    ON
    LooseXEngine

    string

    否

    開啟 X-Engine 儲存引擎功能，取值範圍如下：

    • ON：叢集開啟 X-Engine 引擎。

    • OFF：叢集關閉 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

    否

    儲存計費類型。取值範圍如下：

    • Postpaid：按容量計費（按量付費）。

    • Prepaid：按空間計費（包年包月）。

    Prepaid
    StorageAutoScale

    string

    否

    標準版叢集是否開啟儲存自動擴容。取值範圍如下：

    • Enable：開啟儲存自動擴容。

    • Disable：關閉儲存自動擴容。

    Enable
    StorageUpperBound

    integer

    否

    設定標準版叢集儲存自動擴容上限，單位：GB。

    說明

    取值最大為 32000。

    800
    ProvisionedIops

    integer

    否

    1000
    BurstingEnabled

    string

    否

    ESSD AutoPL 雲端硬碟是否開啟 IO 效能突發。取值：

    • true：開啟

    • false：不開啟（預設）

    說明

    當 StorageType 為 ESSDAUTOPL 時才支援該參數。

    false
    TargetMinorVersion

    string

    否

    目標核心小版本。

    8.0.1.1.54
    StorageEncryption

    boolean

    否

    是否開啟雲端硬碟加密。取值範圍如下：

    • true: 開啟。

    • false: 關閉（預設值）。

    說明

    當參數 DBType 為 MySQL 時，該參數才生效。

    說明

    僅參數 StorageType 為標準版儲存類型時，該參數才生效。

    StorageEncryptionKey

    string

    否

    執行個體同地域內的雲端硬碟加密自訂金鑰 ID。傳入此參數表示自動開啟雲端硬碟加密（開啟後無法關閉）。若使用預設的服務金鑰進行雲端硬碟加密請留空該參數。

    您可以在金鑰管理服務控制台查看金鑰 ID，也可以建立新的金鑰。

    說明

    當參數 DBType 為 MySQL 時，該參數才生效。

    說明

    僅參數 StorageType 為標準版儲存類型時，該參數才生效。

    1022xxxxxxxx
    SourceUid

    integer

    否

    跨帳號備份恢復場景下來源備份集所屬 uid。

    1022xxxxxxxx
    CloudProvider

    string

    否

    執行個體所屬的雲端服務商。

    ENS
    EnsRegionId

    string

    否

    建立 ENS 資料庫時，需要指定 ENS 的節點 ID。

    vn-hanoi-3
    AutoUseCoupon

    boolean

    否

    是否自動使用優惠券，取值：

    • true（預設）：使用優惠券。

    • false：不使用優惠券。

    true
    PromotionCode

    string

    否

    優惠券編號，不填時使用預設優惠券。

    727xxxxxx934

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    DBClusterId

    string

    叢集 ID。

    pc-bp1s826a1up******
    OrderId

    string

    訂單 ID。

    211454967******
    RequestId

    string

    請求 ID。

    E56531A4-E552-40BA-9C58-137B80******
    ResourceGroupId

    string

    資源群組 ID。

    rg-***************
    AgenticDbClusterId

    string

    AgenticDbClusterDescription

    string

    樣本

    正常返回樣本

    JSON格式

    {
  "DBClusterId": "pc-bp1s826a1up******",
  "OrderId": "211454967******",
  "RequestId": "E56531A4-E552-40BA-9C58-137B80******",
  "ResourceGroupId": "rg-***************",
  "AgenticDbClusterId": "",
  "AgenticDbClusterDescription": ""
}

    錯誤碼

    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 MissParameter.GDNId The GDNId parameter is required. 需要指定的 GDNId。
    400 EntityNotExist.ResourceGroup The resource group does not exist.. 資源群組不存在。

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

    變更歷史

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