调用CreateDBInstance接口创建一个云数据库ClickHouse社区兼容版集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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 | 内核版本,取值:
|
DBClusterCategory | String | 是 | Basic | 副本配置,取值说明:
|
DBClusterClass | String | 是 | S8 | 集群规格。
|
DBNodeGroupCount | String | 是 | 1 | 节点数量。
|
DBNodeStorage | String | 是 | 100 | 单节点存储空间,取值范围:100 GB~32000 GB。 说明 步长为100 GB。 |
DBClusterNetworkType | String | 是 | VPC | 网络类型,目前只支持VPC。 |
DBClusterDescription | String | 否 | test | 集群描述。 |
PayType | String | 是 | Prepaid | 付费类型,取值说明:
|
Period | String | 否 | Month | 仅当付费类型为Prepaid时,该参数才生效且为必填参数。 预付费集群为包年或包月类型,取值说明:
|
UsedTime | String | 否 | 1 | 仅当付费类型为Prepaid时,该参数才生效且为必填参数。 预付费集群的购买时长。
|
VPCId | String | 是 | vpc-bp175iuvg8nxqraf2**** | VPC ID。 |
VSwitchId | String | 是 | vsw-bp1gzt31twhlo0sa5**** | 交换机ID。 |
ClientToken | String | 否 | AB | 用于保证请求的幂等性。字符串格式,不超过64个ASCII字符即可。 |
DbNodeStorageType | String | 是 | CloudESSD_PL2 | 存储类型,取值说明:
|
EncryptionKey | String | 否 | 0d2470df-da7b-4786-b981-9a164dae**** | 加密类型为CloudDisk时,该参数为必填参数。 云盘加密的密钥ID。您可以在密钥管理服务控制台查看密钥ID,也可以创建新的密钥。 说明 加密类型为空时,不用填写该参数。 |
EncryptionType | String | 否 | CloudDisk | 加密类型。目前只支持云盘加密,值为CloudDisk。 说明 不填写该参数时,表示不加密。 |
BackupSetID | String | 否 | b-12af23adsf | 备份集ID。您可以通过调用DescribeBackups接口查询备份集ID。 说明 当云数据库ClickHouse集群进行数据恢复时,该参数为必填项。 |
SourceDBClusterId | String | 否 | cc-bp1lxbo89u950**** | 源集群ID。您可以通过调用DescribeDBClusters接口查询备份集ID。 说明 当云数据库ClickHouse集群进行数据恢复时,该参数为必填项。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
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=1
&DBNodeStorage=100
&DBClusterNetworkType=VPC
&DBClusterDescription=test
&PayType=Prepaid
&Period=Month
&UsedTime=1
&VPCId=vpc-bp175iuvg8nxqraf2****
&VSwitchId=vsw-bp1gzt31twhlo0sa5****
&ClientToken=AB
&DbNodeStorageType=CloudESSD_PL2
&EncryptionKey=0d2470df-da7b-4786-b981-9a164dae****
&EncryptionType=CloudDisk
&BackupSetID=b-12af23adsf
&SourceDBClusterId=cc-bp1lxbo89u950****
&公共请求参数
正常返回示例
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. | 系统暂时不可用,请稍后重试 |
访问错误中心查看更多错误码。