调用CreateDBCluster API创建湖仓版集群-云原生数据仓库AnalyticDB-阿里云

创建湖仓版集群。

接口说明

当前服务的接入地址请参见服务接入点。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:CreateDBCluster	create	全部资源 ``	adb:DiskEncryption	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看指定湖仓版集群的地域 ID。	cn-hangzhou
ZoneId	string	是	可用区 ID。说明您可以调用 DescribeRegions 接口查看指定湖仓版集群的可用区 ID。	cn-hangzhou-h
DBClusterVersion	string	是	湖仓版集群的版本，取值：5.0。	5.0
DBClusterNetworkType	string	是	集群网络类型。仅支持 VPC（专有网络）类型。	VPC
DBClusterDescription	string	否	集群描述。不能以`http://`或者`https://`开头。长度为 2~256 个字符。	test
PayType	string	是	付费类型。取值说明： Postpaid：按量付费。 Prepaid：包年包月。	Prepaid
Period	string	否	指定包年包月集群为包年或包月类型。取值说明： Year：包年类型。 Month：包月类型。说明 PayType 为 Prepaid（即包年包月）时，本参数为必填参数。	Month
UsedTime	string	否	指定包年包月集群的购买时长。取值说明：当 Period 为 Year 时，UsedTime 取值范围为：1~3（整数）。当 Period 为 Month 时，UsedTime 取值范围为：1~9（整数）。说明 PayType 为 Prepaid（即包年包月）时，本参数为必填参数。	3
VPCId	string	是	专有网络 ID。	vpc-bp1at5ze0t5u3xtqn****
VSwitchId	string	是	虚拟交换机 ID。	vsw-bp1aadw9k19x6cis9****
StorageResource	string	否	存储预留资源。取值范围：0ACU～2064ACU，步长：24。1 ACU 约等于 1 核 4 GB。说明参数填写时，需要带单位。	24ACU
ComputeResource	string	否	计算预留资源。取值范围：0ACU～4096ACU，步长：16。1 ACU 约等于 1 核 4 GB。说明参数填写时，需要带单位。	16ACU
EnableDefaultResourcePool	boolean	否	计算预留资源是否全部分配给默认资源组（user_default），取值说明： true（默认值）：是 false：否	true
ResourceGroupId	string	否	资源组 ID。	rg-4690g37929****
Tag	array<object>	否	标签列表信息。
	object	否
Key	string	否	标签键，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。说明最多支持 64 个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。	testkey1
Value	string	否	标签值，可以根据标签过滤集群列表。最多 20 对标签，各个标签对的数字 n 必须不同，且必须是从 1 开始的连续整数。`Tag.N.Key`对应的值为`Tag.N.Value`。说明最多支持 64 个字符，不能以`aliyun`、`acs:`、`http://`或者`https://`开头。	test1
SourceDbClusterId	string	否	AnalyticDB MySQL 数仓版集群的源实例 ID，指定该参数时为从数仓版集群恢复湖仓版集群。	amv-bp1r053byu48p****
BackupSetId	string	否	基于备份集恢复时，使用的备份集的 ID。说明您可以调用 DescribeBackups 接口查看集群的备份列表。	1880808684
RestoreToTime	string	否	基于备份集恢复的时间点。	2023-09-20T03:13:56Z
RestoreType	string	否	恢复方式，取值： backup：基于备份集恢复，您还需要传入参数 BackupSetId、SourceDBClusterId。 timepoint：基于时间点恢复，您还需要传入参数 RestoreToTime、SourceDBClusterId。	backup
ProductForm	string	否	产品形态。取值为： IntegrationForm：融合形态。 LegacyForm：湖仓版。	LegacyForm
ReservedNodeSize	string	否	预留节点规格，单位为 ACU。	8ACU
ReservedNodeCount	integer	否	预留节点数。企业版默认为 3 节点，步长为 3。基础版默认为 1 节点。说明仅 ProductForm 取值为 IntegrationForm 时，填写该参数	3
KmsId	string	否	用于加密云盘数据的密钥 ID。说明仅当 AnalyticDB MySQL 集群开启云盘加密时才会使用该参数。	e1935511-cf88-1123-a0f8-1be8d251****
DiskEncryption	boolean	否	是否开启云盘加密。	false
CloneSourceRegionId	string	否	源集群所在的地域。说明跨地域克隆时该参数必填。	cn-beijing
ProductVersion	string	否	产品版本。取值为： BasicVersion：基础版。 EnterpriseVersion：企业版。说明仅 ProductForm 取值为 IntegrationForm 时，填写该参数	BasicVersion
SecondaryZoneId	string	否	备可用区 ID。说明本参数和 ZoneId 参数传入的值不能相同。	cn-beijing-h
SecondaryVSwitchId	string	否	备虚拟交换机 ID。说明本参数和 VSwitchId 参数传入的值不能相同。	vsw-bp1aadw9k19x451gx****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
ResourceGroupId	string	默认资源组的 ID。	rg-4690g37929****
DBClusterId	string	AnalyticDB MySQL 湖仓版（3.0）集群 ID。	amv-bp1r053byu48p****
OrderId	string	订单 ID。	202353278****

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "ResourceGroupId": "rg-4690g37929****",
  "DBClusterId": "amv-bp1r053byu48p****",
  "OrderId": "202353278****"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-09-24	OpenAPI 入参发生变更	查看变更详情
2024-05-23	OpenAPI 入参发生变更	查看变更详情
2024-05-09	OpenAPI 入参发生变更	查看变更详情
2023-08-28	OpenAPI 入参发生变更	查看变更详情
2023-07-27	OpenAPI 入参发生变更	查看变更详情