创建数仓版集群。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
adb:CreateDBCluster | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 是 | 系列。取值说明:
说明
仅中国内地地域和新加坡地域支持购买预留模式集群版。其中,新加坡地域仅支持在按量付费模式下购买预留模式集群版。
说明
当 DBClusterCategory 为 Cluster 时,Mode 参数必须填写 Reserver;当 DBClusterCategory 为 MixedStorage 时,Mode 参数必须填写 Flexible,否则会导致创建集群失败。
| Cluster |
DBClusterClass | string | 否 | 集群规格,取值:
说明
Mode 取值为 Reserver(即预留模式)时,本参数必填。
| C8 |
DBNodeGroupCount | string | 否 | 节点组数量,取值范围为:1~200(整数)。 说明
Mode 取值为 Reserver(即预留模式)时,本参数必填。
| 2 |
DBNodeStorage | string | 否 | 节点存储空间,单位:GB。取值说明:
说明
| 200 |
DBClusterNetworkType | string | 是 | 网络类型:VPC。 | VPC |
DBClusterDescription | string | 否 | 集群描述。
| test |
PayType | string | 是 | 付费类型。取值说明:
| Postpaid |
Period | string | 否 | 指定预付费集群为包年或包月类型。取值说明:
说明
PayType 为 Prepaid(即预付费(包年包月))时,本参数为必填参数。
| Year |
UsedTime | string | 否 | 预付费集群的购买时长。取值说明:
说明
| 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 开始的连续整数。 说明
最多支持 64 个字符,不能以 aliyun 、acs: 、http:// 或者https:// 开头。
| tag1 |
Value | string | 否 | 标签值,可以根据标签过滤集群列表。最多 20 对标签,各个标签对的数字 n 必须不同,且必须是从 1 开始的连续整数。 说明
最多支持 64 个字符,不能以 aliyun 、acs: 、http:// 或者https:// 开头。
| test1 |
Mode | string | 是 | 模式。取值说明:
| Reserver |
StorageResource | string | 否 | 预留参数,不涉及。 | 无 |
StorageType | string | 否 | 预留参数,不涉及。 | 无 |
ComputeResource | string | 否 | 计算资源用于数据计算,增加计算资源可以提高数据查询速度。计算资源分为集群版和单机版,其中:
说明
| 32Core128GBNEW |
RestoreType | string | 否 | 预留参数,不涉及。 | 无 |
SourceDBInstanceName | string | 否 | 预留参数,不涉及。 | 无 |
BackupSetID | string | 否 | 预留参数,不涉及。 | 无 |
RestoreTime | string | 否 | 预留参数,不涉及。 | 无 |
ElasticIOResource | string | 否 | 弹性 IO 资源(Elastic IO Unit,简称 EIU),更多详情,请参见 EIU 详解。 | 0 |
DiskEncryption | boolean | 否 | 是否开启云盘加密。取值:
| true |
KmsId | string | 否 | 用于云盘加密的 kmsId,仅当 DiskEncryption 为 true 时有效。 | xxxxxxxx-xxxx-xxxx-xxxx-xxxx |
EnableSSL | boolean | 否 | 是否开启 SSL 链路加密功能,取值:
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"ResourceGroupId": "rg-4690g37929****",
"DBClusterId": "am-bp1r053byu48p****",
"OrderId": "202353278****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-25 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-03-05 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-08-02 | OpenAPI 入参发生变更 | 查看变更详情 |