CreateDBCluster - 创建集群

更新时间:

创建湖仓版集群。

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看指定湖仓版集群的地域 ID。
cn-hangzhou
ZoneIdstring

可用区 ID。

说明 您可以调用 DescribeRegions 接口查看指定湖仓版集群的可用区 ID。
cn-hangzhou-h
DBClusterVersionstring

湖仓版集群的版本,取值:5.0

5.0
DBClusterNetworkTypestring

集群网络类型。仅支持 VPC(专有网络)类型。

VPC
DBClusterDescriptionstring

集群描述。

  • 不能以http://或者https://开头。
  • 长度为 2~256 个字符。
test
PayTypestring

付费类型。取值说明:

  • Postpaid:按量付费。
  • Prepaid:包年包月。
Prepaid
Periodstring

指定包年包月集群为包年或包月类型。取值说明:

  • Year:包年类型。
  • Month:包月类型。
说明 PayType 为 Prepaid(即包年包月)时,本参数为必填参数。
Month
UsedTimestring

指定包年包月集群的购买时长。取值说明:

  • Period 为 Year 时,UsedTime 取值范围为:1~3(整数)。
  • Period 为 Month 时,UsedTime 取值范围为:1~9(整数)。
说明 PayType 为 Prepaid(即包年包月)时,本参数为必填参数。
3
VPCIdstring

专有网络 ID。

vpc-bp1at5ze0t5u3xtqn****
VSwitchIdstring

虚拟交换机 ID。

vsw-bp1aadw9k19x6cis9****
StorageResourcestring

存储预留资源。取值范围:0ACU~2064ACU,步长:24。1 ACU 约等于 1 核 4 GB。

说明 参数填写时,需要带单位。
24ACU
ComputeResourcestring

计算预留资源。取值范围:0ACU~4096ACU,步长:16。1 ACU 约等于 1 核 4 GB。

说明 参数填写时,需要带单位。
16ACU
EnableDefaultResourcePoolboolean

计算预留资源是否全部分配给默认资源组(user_default),取值说明:

  • true(默认值):是
  • false:否
true
ResourceGroupIdstring

资源组 ID。

rg-4690g37929****
Tagarray<object>

标签列表信息。

object
Keystring

标签键,可以根据标签过滤集群列表。最多 20 对标签,各个标签对的数字 n 必须不同,且必须是从 1 开始的连续整数。Tag.N.Key对应的值为Tag.N.Value

说明 最多支持 64 个字符,不能以aliyunacs:http://或者https://开头。
testkey1
Valuestring

标签值,可以根据标签过滤集群列表。最多 20 对标签,各个标签对的数字 n 必须不同,且必须是从 1 开始的连续整数。Tag.N.Key对应的值为Tag.N.Value

说明 最多支持 64 个字符,不能以aliyunacs:http://或者https://开头。
test1
SourceDbClusterIdstring

AnalyticDB MySQL 数仓版集群的源实例 ID,指定该参数时为从数仓版集群恢复湖仓版集群。

amv-bp1r053byu48p****
BackupSetIdstring

基于备份集恢复时,使用的备份集的 ID。

说明 您可以调用 DescribeBackups 接口查看集群的备份列表。
1880808684
RestoreToTimestring

基于备份集恢复的时间点。

2023-09-20T03:13:56Z
RestoreTypestring

恢复方式,取值:

  • backup:基于备份集恢复,您还需要传入参数 BackupSetIdSourceDBClusterId
  • timepoint:基于时间点恢复,您还需要传入参数 RestoreToTimeSourceDBClusterId
backup
ProductFormstring

产品形态。取值为:

  • IntegrationForm:融合形态。
  • LegacyForm:湖仓版。
LegacyForm
ReservedNodeSizestring

预留节点规格,单位为 ACU。

8ACU
ReservedNodeCountinteger

预留节点数。

  • 企业版默认为 3 节点,步长为 3。
  • 基础版默认为 1 节点。
说明 仅 ProductForm 取值为 IntegrationForm 时,填写该参数
3
KmsIdstring

用于加密云盘数据的密钥 ID。

说明 仅当 AnalyticDB MySQL 集群开启云盘加密时才会使用该参数。
e1935511-cf88-1123-a0f8-1be8d251****
DiskEncryptionboolean

是否开启云盘加密。

false
CloneSourceRegionIdstring

源集群所在的地域。

说明 跨地域克隆时该参数必填。
cn-beijing
ProductVersionstring

产品版本。取值为:

  • BasicVersion:基础版。
  • EnterpriseVersion:企业版。
说明 仅 ProductForm 取值为 IntegrationForm 时,填写该参数
BasicVersion
SecondaryZoneIdstring

备可用区 ID。

说明 本参数和 ZoneId 参数传入的值不能相同。
cn-beijing-h
SecondaryVSwitchIdstring

备虚拟交换机 ID。

说明 本参数和 VSwitchId 参数传入的值不能相同。
vsw-bp1aadw9k19x451gx****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
ResourceGroupIdstring

默认资源组的 ID。

rg-4690g37929****
DBClusterIdstring

AnalyticDB MySQL 湖仓版(3.0)集群 ID。

amv-bp1r053byu48p****
OrderIdstring

订单 ID。

202353278****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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