CreateDBInstance - 建立叢集 -

調用CreateDBInstance介面建立ClickHouse企業版叢集。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:CreateDBInstance

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用於保證請求的等冪性，防止重複提交請求。該參數值由用戶端產生，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元，且該參數值中不能包含非 ASCII 字元。	AB
RegionId	string	是	地區 ID。	cn-hangzhou
ZoneId	string	否	可用性區域 ID。	cn-hangzhou-h
VpcId	string	否	VPC ID。	vpc-uf6xmupdn7v6ui9f****
VswitchId	string	否	交換器 ID。	vsw-uf632qye9oqt4x4sr****
DBInstanceDescription	string	否	叢集說明。	叢集測試
EngineVersion	string	否	引擎版本。	23.8
ScaleMin	string	否	serverless Auto Scaling最小值。不推薦使用，當前建議使用 NodeCount，NodeScaleMin，NodeScaleMax 設定彈效能力。	8
ScaleMax	string	否	serverless Auto Scaling最大值。不推薦使用，當前建議使用 NodeCount，NodeScaleMin，NodeScaleMax 設定彈效能力。	32
Engine	string	否	引擎類型。	clickhouse
MultiZone	array<object>	否	多可用性區域配置。
	object	否	多可用性區域配置。
ZoneId	string	否	可用性區域 ID。	cn-hangzhou-h
VSwitchIds	array	否	交換器 ID。
	string	否	交換器 ID。	vsw-8vb05l07h3sdayqhe****
DeploySchema	string	否	叢集可用性區域部署狀態。	multi_az
SourceDBInstanceId	string	否	叢集例 ID。	cc-2ze1*********
BackupSetId	string	否	備份組 ID。	1
ResourceGroupId	string	否	叢集資源群組 ID。	rg-*****
NodeScaleMax	integer	否	serverless 節點Auto Scaling最大值。取值範圍 4-32，且必須大於最小值	4
NodeScaleMin	integer	否	serverless 節點Auto Scaling最小值。取值範圍 4-32	32
NodeCount	integer	否	節點個數，取值範圍 2-16。使用 NodeScaleMin、NodeScaleMax 配置彈性區間時必填。	2
StorageQuota	integer	否	儲存預購量（GB）	100
StorageType	string	否	儲存類型。	OSS
DBTimeZone	string	否	資料庫核心時區設定，應為 IANA 時區標識符。
Category	string	否
Tags	array<object>	否
	object	否
Key	string	否		user_123
Value	string	否		樣本字串

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	F5178C10-1407-4987-9133-DE4DC9119F75
Data	object	返回結果。
DBInstanceId	string	叢集 ID。	cc-bp100p4q1g9z3****
OrderId	integer	訂單 ID。	21154955706****
ConnectionString	string	串連地址。	cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com

樣本

正常返回樣本

JSON格式

{
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "Data": {
    "DBInstanceId": "cc-bp100p4q1g9z3****",
    "OrderId": 0,
    "ConnectionString": "cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com"
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

變更歷史

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