幫助中心
首頁 ApsaraDB for ClickHouse 開發參考 API參考（社區相容版） API目錄 其他 CreateDBInstance - 建立叢集

CreateDBInstance - 建立叢集

更新時間：
Copy as MD
產品

建立一個雲資料庫ClickHouse叢集。

介面說明

請確保在使用該介面前，已充分瞭解雲資料庫 ClickHouse 產品的收費方式和價格。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:CreateDBInstance

create

*全部資源

*

 無 無

請求參數

名稱

類型

必填

描述

樣本值
RegionId

string

是

地區 ID。您可以通過調用 DescribeRegions 介面查詢地區 ID。

cn-hangzhou
ZoneId

string

否

可用性區域 ID。您可以通過調用 DescribeRegions 介面查詢可用性區域 ID。

cn-hangzhou-h
DBClusterVersion

string

是

核心版本，取值：

  • 21.8.10.19

  • 22.8.5.29

枚舉值：

  • 22.8.5.29 :

    22.8.5.29

  • 21.8.10.19 :

    21.8.10.19

22.8.5.29
DBClusterCategory

string

是

副本配置，取值說明：

  • Basic：單副本版。

  • HighAvailability：雙副本版。

枚舉值：

  • Basic :

    Basic

  • HighAvailability :

    HighAvailability

Basic
DBClusterClass

string

是

叢集規格。

  • 單副本版，取值：

    • LS20：大儲存型 20 核 88 GB。

    • LS40：大儲存型 40 核 176 GB。

    • LS80：大儲存型 80 核 352 GB。

    • S8：標準型 8 核 32 GB。

    • S16：標準型 16 核 64 GB。

    • S32：標準型 32 核 128 GB。

    • S64：標準型 64 核 256 GB。

    • S80：標準型 80 核 384 GB。

    • S104：標準型 104 核 384 GB。

  • 雙副本版，取值：

    • LC20：大儲存型 20 核 88 GB。

    • LC40：大儲存型 40 核 176 GB。

    • LC80：大儲存型 80 核 352 GB。

    • C8：標準型 8 核 32 GB。

    • C16：標準型 16 核 64 GB。

    • C32：標準型 32 核 128 GB。

    • C64：標準型 64 核 256 GB。

    • C80：標準型 80 核 384 GB。

    • C104：標準型 104 核 384 GB。

  • 單副本版，取值：

    • S8：8 核 32 GB。

    • S16：16 核 64 GB。

    • S32：32 核 128 GB。

    • S64 ：64 核 256 GB。

    • S104：104 核 384 GB。

  • 雙副本版，取值：

    • C8：8 核 32 GB。

    • C16：16 核 64 GB。

    • C32：32 核 128 GB。

    • C64 ：64 核 256 GB。

    • C104：104 核 384 GB。

S8
DBNodeGroupCount

string

是

節點數量。

  • 單副本版，取值範圍：1~48。

  • 雙副本版，取值範圍：1~24。

1
DBNodeStorage

string

是

單節點儲存空間，取值範圍：100 GB~32000 GB。

說明

步長為 100 GB。

100
DBClusterNetworkType

string

是

網路類型，目前只支援 VPC。

VPC
DBClusterDescription

string

否

叢集描述。

test
PayType

string

是

付費類型，取值說明：

  • Postpaid：隨用隨付。

  • Prepaid：預付費（訂用帳戶）。

枚舉值：

  • Prepaid :

    Prepaid

  • Postpaid :

    Postpaid

Prepaid
Period

string

否

預付費叢集為包年或包月類型，取值說明：

重要 當付費類型為 Prepaid 時，該參數才生效且為必填參數。

  • Year：包年。

  • Month：包月。

Month
UsedTime

string

否

預付費叢集的購買時間長度。

重要 當付費類型為 Prepaid 時，該參數才生效且為必填參數。

  • 當 Period 為 Year 時，取值範圍：1~3（整數）。

  • 當 Period 為 Month 時，取值範圍：1~9（整數）。

1
VPCId

string

是

VPC ID。

vpc-bp175iuvg8nxqraf2****
VSwitchId

string

是

交換器 ID。

vsw-bp1gzt31twhlo0sa5****
ClientToken

string

否

用於保證請求的等冪性。字串格式，不超過 64 個 ASCII 字元即可。

AB
DbNodeStorageType

string

是

儲存類型，取值說明：

  • CloudESSD：ESSD PL1 雲端硬碟。

  • CloudESSD_PL2：ESSD PL2 雲端硬碟。

  • CloudESSD_PL3：ESSD PL3 雲端硬碟。

  • CloudEfficiency：高效雲端硬碟。

CloudESSD_PL2
EncryptionKey

string

否

加密類型為 CloudDisk 時，該參數為必填參數。

雲端硬碟加密的金鑰識別碼。您可以在Key Management Service控制台查看金鑰識別碼，也可以建立新的密鑰。

說明

加密類型為空白時，不用填寫該參數。

0d2470df-da7b-4786-b981-9a164dae****
EncryptionType

string

否

加密類型。目前只支援雲端硬碟加密，值為 CloudDisk。

說明

不填寫該參數時，表示不加密。

CloudDisk
BackupSetID

string

否

備份組 ID。您可以通過調用 DescribeBackups 介面查詢備份組 ID。

說明

當雲資料庫 ClickHouse 叢集進行資料恢複時，該參數為必填項。

b-12af23adsf
SourceDBClusterId

string

否

源叢集 ID。您可以通過調用 DescribeDBClusters 介面查詢備份組 ID。

說明

當雲資料庫 ClickHouse 叢集進行資料恢複時，該參數為必填項。

cc-bp1lxbo89u950****
ResourceGroupId

string

否

叢集所屬的資源群組 ID。

rg-4690g37929****
ZoneIdBak

string

否

備可用性區域。

cn-hangzhou-k
VSwitchBak

string

否

備專用網路交換器。

vsw-bp1gzt31twhlo0sa5****
ZondIdBak2

string

否

備可用性區域 2。

cn-hangzhou-j
VSwitchBak2

string

否

備專用網路交換器 2。

vsw-bp1gzt31twhlo0sa5****
AutoRenew

boolean

否

是否開啟自動續約。

說明

僅在 PayType = Prepaid，預付費時生效。

false
Tags

array<object>

否

標籤資訊。

object

否

標籤資訊。

key

string

否

標籤鍵。

user123
value

string

否

標籤值。

樣本字串

返回參數

名稱

類型

描述

樣本值

object

返回結果。

RequestId

string

請求 ID。

F5178C10-1407-4987-9133-DE4DC9119F75
DBClusterId

string

叢集 ID。

cc-bp1qx68m06981****
OrderId

string

訂單 ID。

21137950671****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "DBClusterId": "cc-bp1qx68m06981****",
  "OrderId": "21137950671****"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述
500 InternalError An error occurred while processing your request. 系統內部錯誤，請稍後重試
503 ServiceUnavailable An error occurred while processing your request. 系統暫時不可用，請稍後重試

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

變更歷史

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

上一篇：CreateBackupPolicy - 建立備份策略下一篇：CreateOSSStorage - 建立冷儲存