创建一个云数据库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 | 是 | 内核版本,取值:
| 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 错误码发生变更 | 查看变更详情 |