CreateDBInstance - 创建集群_云数据库 ClickHouse-阿里云帮助中心

调用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 弹性伸缩最小值。	8
ScaleMax	string	否	serverless 弹性伸缩最大值。	32
Engine	string	否	引擎类型。	clickhouse
MultiZone	array	否	多可用区配置。
	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-*****

返回参数

名称	类型	描述	示例值
	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.

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

变更历史

更多信息，参考变更详情。