創建一個云數據庫ClickHouse集群。
接口說明
請確保在使用該接口前,已充分了解云數據庫 ClickHouse 產品的收費方式和價格。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
clickhouse:CreateDBInstance | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。您可以通過調用 DescribeRegions 接口查詢地域 ID。 | cn-hangzhou |
ZoneId | string | 否 | 可用區 ID。您可以通過調用 DescribeRegions 接口查詢可用區 ID。 | cn-hangzhou-h |
DBClusterVersion | string | 是 | 內核版本,取值:
| 22.8.5.29 |
DBClusterCategory | string | 是 | 副本配置,取值說明:
| Basic |
DBClusterClass | string | 是 | 集群規格。
| S8 |
DBNodeGroupCount | string | 是 | 節點數量。
| 1 |
DBNodeStorage | string | 是 | 單節點存儲空間,取值范圍:100 GB~32000 GB。 說明
步長為 100 GB。
| 100 |
DBClusterNetworkType | string | 是 | 網絡類型,目前只支持 VPC。 | VPC |
DBClusterDescription | string | 否 | 集群描述。 | test |
PayType | string | 是 | 付費類型,取值說明:
| Prepaid |
Period | string | 否 | 預付費集群為包年或包月類型,取值說明: 注意 當付費類型為 Prepaid 時,該參數才生效且為必填參數。
| Month |
UsedTime | string | 否 | 預付費集群的購買時長。 注意 當付費類型為 Prepaid 時,該參數才生效且為必填參數。
| 1 |
VPCId | string | 是 | VPC ID。 | vpc-bp175iuvg8nxqraf2**** |
VSwitchId | string | 是 | 交換機 ID。 | vsw-bp1gzt31twhlo0sa5**** |
ClientToken | string | 否 | 用于保證請求的冪等性。字符串格式,不超過 64 個 ASCII 字符即可。 | AB |
DbNodeStorageType | string | 是 | 存儲類型,取值說明:
| CloudESSD_PL2 |
EncryptionKey | string | 否 | 加密類型為 CloudDisk 時,該參數為必填參數。 云盤加密的密鑰 ID。您可以在密鑰管理服務控制臺查看密鑰 ID,也可以創建新的密鑰。 說明
加密類型為空時,不用填寫該參數。
| 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 |
返回參數
示例
正常返回示例
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. | 系統暫時不可用,請稍后重試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-23 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-02-21 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-02-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-08 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-03-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2021-11-04 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2021-11-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |