调用CreateDBInstance接口创建一个云数据库ClickHouse集群。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDBInstance

系统规定参数。取值:CreateDBInstance

RegionId String cn-hangzhou

地域ID。您可以通过调用DescribeRegions接口查询地域ID。

ZoneId String cn-hangzhou-h

可用区ID。您可以通过调用DescribeRegions接口查询可用区ID。

DBClusterVersion String 20.8.7.15

内核版本,取值:

  • 20.3.10.75
  • 20.8.7.15
  • 21.8.10.19
DBClusterCategory String Basic

副本配置,取值说明:

  • Basic:单副本版。
  • HighAvailability:双副本版。
DBClusterClass String S8

集群规格。

  • 单副本版,取值:
    • S4-NEW
    • S8
    • S16
    • S32
    • S64
    • S104
  • 双副本版,取值:
    • C4-NEW
    • C8
    • C16
    • C32
    • C64
    • C104
DBNodeGroupCount String 2

节点数量。

  • 单副本版,取值范围:1~48。
  • 双副本版,取值范围:1~24。
DBNodeStorage String 100

单节点存储空间,取值范围:100 GB~32000 GB。

说明 步长为100 GB。
DBClusterNetworkType String VPC

网络类型,目前只支持VPC。

DBClusterDescription String test

集群描述。

PayType String Postpaid

付费类型,取值说明:

  • Postpaid:按量付费。
  • Prepaid:预付费(包年包月)。
Period String Year

付费类型为Prepaid时,该参数为必填参数。

预付费集群为包年或包月类型,取值说明:

  • Year:包年。
  • Month:包月。
说明 付费类型为Postpaid时,不用填写该参数。
UsedTime String 3

付费类型为Prepaid时,该参数为必填参数。

预付费集群的购买时长。

  • 当Period为Year时,取值范围:1~3。
  • 当Period为Month时,取值范围:1~9。
说明 付费类型为Postpaid,不用填写该参数。
VPCId String vpc-bp175iuvg8nxqraf2****

VPC ID。

VSwitchId String vsw-bp1gzt31twhlo0sa5****

交换机ID。

ClientToken String AB

用于保证请求的幂等性。字符串格式,不超过64个ASCII字符即可。

DbNodeStorageType String CloudESSD

存储类型,取值说明:

  • CloudESSD:ESSD PL1云盘。
  • CloudESSD_PL2:ESSD PL2云盘。
  • CloudESSD_PL3:ESSD PL3云盘。
  • CloudEfficiency:高效云盘。
EncryptionKey String 0d2470df-da7b-4786-b981-9a164dae****

加密类型为CloudDisk时,该参数为必填参数。

云盘加密的密钥ID。您可以在密钥管理服务控制台查看密钥ID,也可以创建新的密钥。详情请参见管理密钥

说明 加密类型为空时,不用填写该参数。
EncryptionType String CloudDisk

加密类型。目前只支持云盘加密,值为CloudDisk

说明 不填写该参数时,表示不加密。

返回数据

名称 类型 示例值 描述
RequestId String F5178C10-1407-4987-9133-DE4DC9119F75

请求ID。

DBClusterId String cc-bp1qx68m06981****

集群ID。

OrderId String 21137950671****

订单ID。

示例

请求示例

http(s)://clickhouse.aliyuncs.com/?Action=CreateDBInstance
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-h
&DBClusterVersion=20.8.7.15
&DBClusterCategory=Basic
&DBClusterClass=S8
&DBNodeGroupCount=2
&DBNodeStorage=100
&DBClusterNetworkType=VPC
&DBClusterDescription=test
&PayType=Postpaid
&Period=Year
&UsedTime=3
&VPCId=vpc-bp175iuvg8nxqraf2****
&VSwitchId=vsw-bp1gzt31twhlo0sa5****
&ClientToken=AB
&DbNodeStorageType=CloudESSD
&EncryptionKey=0d2470df-da7b-4786-b981-9a164dae****
&EncryptionType=CloudDisk
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDBInstanceResponse>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <DBClusterId>cc-bp1qx68m06981****</DBClusterId>
    <OrderId>21137950671****</OrderId>
</CreateDBInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
500 InternalError An error occurred while processing your request. 系统内部错误,请稍后重试
503 ServiceUnavailable An error occurred while processing your request. 系统暂时不可用,请稍后重试

访问错误中心查看更多错误码。