CreateDBCluster - 创建集群

更新时间:
复制为 MD 格式

创建数仓版集群。

接口说明

注意事项

  • 集群创建成功后,将按照您选的集群规格计费。数仓版集群的计费项与定价,详情请参见数仓版计费项数仓版产品定价

  • 数仓版目前已停止新购。您可以购买企业版或基础版。企业版、基础版与湖仓版的特性相同,详细介绍请参见产品系列

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

adb:CreateDBCluster

create

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/*

  • adb:DiskEncryption
  • adb:EnableSSL

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

说明

您可以调用 DescribeRegions 接口查看地域 ID。

cn-hangzhou

ZoneId

string

可用区 ID。

说明

您可以调用 DescribeRegions 接口查看可用区 ID。

cn-hangzhou-h

DBClusterVersion

string

AnalyticDB MySQL 数仓版集群版本。取值:3.0

3.0

DBClusterCategory

string

系列。取值说明:

  • Cluster:预留模式集群版。

说明

仅中国内地地域和新加坡地域支持购买预留模式集群版。其中,新加坡地域仅支持在按量付费模式下购买预留模式集群版。

  • MixedStorage:弹性模式集群版(新版)。

说明

当 DBClusterCategory 为 Cluster 时,Mode 参数必须填写 Reserver;当 DBClusterCategory 为 MixedStorage 时,Mode 参数必须填写 Flexible,否则会导致创建集群失败。

Cluster

DBClusterClass

string

集群规格,取值:

  • C8

  • C32

说明

Mode 取值为 Reserver(即预留模式)时,本参数必填。

C8

DBNodeGroupCount

string

节点组数量,取值范围为:1~200(整数)。

说明

Mode 取值为 Reserver(即预留模式)时,本参数必填。

2

DBNodeStorage

string

节点存储空间,单位:GB。取值说明:

  • 规格为 C8 时,取值范围为:100~1000。

  • 规格为 C32 时,取值范围为:100~8000。

说明
  • Mode 取值为 Reserver(即预留模式)时,本参数必填。

  • 1000 GB 以下步长为 100 GB,1000 GB 以上步长为 1000 GB。

200

DBClusterNetworkType

string

网络类型:VPC

VPC

DBClusterDescription

string

集群描述。

  • 不能以http://或者https开头。

  • 长度为 2~256 个字符。

test

PayType

string

付费类型。取值说明:

  • Postpaid:按量付费。

  • Prepaid:预付费(包年包月)。

Postpaid

Period

string

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

  • Year:包年类型。

  • Month:包月类型。

说明

PayType 为 Prepaid(即预付费(包年包月))时,本参数为必填参数。

Year

UsedTime

string

预付费集群的购买时长。取值说明:

  • 当 Period 为 Year 时,UsedTime 取值范围为:1、2、3、5(整数)。

  • 当 Period 为 Month 时,UsedTime 取值范围为:1~11(整数)。

说明
  • PayType 为 Prepaid(即预付费(包年包月))时,本参数为必填参数。

  • 购买的时间越长价格越优惠,购买 1 年的实际价格会比购买 10 个月或 11 个月更划算。

1

VPCId

string

专有网络 ID。

vpc-bp1at5ze0t5u3xtqn****

VSwitchId

string

虚拟交换机 ID。

vsw-bp1aadw9k19x6cis9****

ClientToken

string

用于保证请求的幂等性。由客户端生成该参数值,保证在不同请求间唯一。大小写敏感、不超过 64 个 ASCII 字符。

123e4567-e89b-12d3-a456-t7241****

ExecutorCount

string

预留参数,不涉及。

ResourceGroupId

string

资源组 ID。

rg-4690g37929****

Tag

array<object>

标签信息列表。

object

Key

string

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

说明

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

tag1

Value

string

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

说明

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

test1

Mode

string

模式。取值说明:

  • Reserver:预留模式。

  • Flexible:弹性模式。

Reserver

StorageResource

string

预留参数,不涉及。

StorageType

string

预留参数,不涉及。

ComputeResource

string

计算资源用于数据计算,增加计算资源可以提高数据查询速度。计算资源分为集群版和单机版,其中:

  • 集群版为 16 核 64 GB(集群版)、24 核 96 GB(集群版)和 32 核及以上规格。集群版支持资源池隔离,分时弹性功能和数据冷热分层。

  • 单机版为 8 核 32 GB 和 16 核 64 GB(单机版)。单机版不提供 SLA 承诺,故障恢复耗时长(大约为 4~8 小时),不建议用于生产环境。

说明
  • 您可以调用 DescribeAvailableResource 接口查询指定地域中可用的计算资源。

  • Mode 取值为 Flexible(即弹性模式)时,本参数必填。

32Core128GBNEW

RestoreType

string

预留参数,不涉及。

SourceDBInstanceName

string

预留参数,不涉及。

BackupSetID

string

预留参数,不涉及。

RestoreTime

string

预留参数,不涉及。

ElasticIOResource

string

弹性 IO 资源(Elastic IO Unit,简称 EIU),更多详情,请参见 EIU 详解

0

DiskEncryption

boolean

是否开启云盘加密。取值:

  • true:是。

  • false:否。

true

KmsId

string

用于云盘加密的 kmsId,仅当 DiskEncryption 为 true 时有效。

xxxxxxxx-xxxx-xxxx-xxxx-xxxx

EnableSSL

boolean

是否开启 SSL 链路加密功能,取值:

  • true:开启。

  • false:关闭。

true

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

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

ResourceGroupId

string

资源组 ID。

rg-4690g37929****

DBClusterId

string

数仓版集群 ID。

am-bp1r053byu48p****

OrderId

string

订单 ID。

202353278****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情