CreateDBCluster_云数据库 PolarDB_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
polardb:CreateDBCluster
Create
全部资源
*
polardb:EncryptionRequired

请求参数

字段名称字段详情
RegionIdstring

地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
ZoneIdstring

可用区 ID。展开详情

示例值:cn-hangzhou-j
Architecturestring

CPU 架构。取值范围如下:展开详情

示例值:X86枚举值:X86ARM
DBTypestring

数据库引擎类型,取值范围如下: 展开详情

示例值:MySQL
DBVersionstring

数据库引擎版本号。展开详情

示例值:5.6参考取值来源:
    DescribeDBClusterVersion
DBNodeClassstring

节点规格,详情请参见如下文档:展开详情

示例值:polar.mysql.x4.medium参考取值来源:
    DescribeDBClusters
ClusterNetworkTypestring

集群网络类型,当前仅支持专有网络,取值固定为 VPC

示例值:VPC参考取值来源:
    DescribeDBClusters
DBClusterDescriptionstring

集群名称,集群名称需满足如下要求:展开详情

示例值:test
PayTypestring

付费类型,取值范围如下: 展开详情

示例值:Postpaid
AutoRenewboolean

是否自动续费,取值范围如下:展开详情

示例值:true
Periodstring

若付费类型为 Prepaid 时,该参数为必传参数。指定预付费集群为包年或包月类型。 展开详情

示例值:Month
UsedTimestring

若付费类型为 Prepaid 时,该参数为必传参数。展开详情

示例值:1
VPCIdstring

专有网络 ID。

示例值:vpc-**********
VSwitchIdstring

虚拟交换机 ID。展开详情

示例值:vsw-**********参考取值来源:
    DescribeVSwitches
CreationOptionstring

创建方式,取值范围如下: 展开详情

示例值:Normal
SourceResourceIdstring

源 RDS 实例 ID 或源 PolarDB 集群 ID。仅当 CreationOptionMigrationFromRDSCloneFromRDSCloneFromPolarDBRecoverFromRecyclebin 时,该参数必填。展开详情

示例值:rm-*************
CloneDataPointstring

克隆数据的时间节点,取值: 展开详情

示例值:LATEST
ClientTokenstring

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

示例值:6000170000591aed949d0f5********************
ResourceGroupIdstring

资源组 ID。

示例值:rg-************
SecurityIPListstring

PolarDB 集群白名单 IP 地址。展开详情

示例值:10.***.***.***
TDEStatusboolean

开启 TDE 加密。取值范围如下:展开详情

示例值:true
GDNIdstring

全球数据库网络 ID。展开详情

示例值: gdn-***********
CreationCategorystring

产品系列,取值范围如下:展开详情

示例值:Normal
DefaultTimeZonestring

集群时区(UTC),可选取值范围为**-12:00~+13:00内的所有整点时间,如00:00**。默认取值为 SYSTEM,默认时区与 Region 所在时区一致。展开详情

示例值:SYSTEM
LowerCaseTableNamesstring

表名是否区分大小写,取值范围如下:展开详情

示例值:1
BackupRetentionPolicyOnClusterDeletionstring

删除集群时备份集保留策略,取值范围如下:展开详情

示例值:NONE参考取值来源:
    DescribeBackupPolicy
StorageSpaceinteger<int64>

按空间计费(包年包月)的存储空间。单位:GB。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:50取值 <= 64000
DBMinorVersionstring

数据库引擎小版本号。取值范围如下:展开详情

示例值:8.0.1参考取值来源:
    DescribeDBClusterVersion
ParameterGroupIdstring

参数模板 ID。展开详情

示例值:pcpg-**************参考取值来源:
    CreateParameterGroup
    DescribeParameterGroups
Tagarray<object>

标签列表。

子级条数 <= 21
ServerlessTypestring

Serverless 类型。当前取值固定为 AgileServerless(敏态)。展开详情

示例值:AgileServerless枚举值:
ScaleMinstring

单节点伸缩下限。取值范围:1 PCU~31 PCU。展开详情

示例值:1
ScaleMaxstring

单节点伸缩上限。取值范围:1 PCU~32 PCU。展开详情

示例值:3
AllowShutDownstring

是否开启无活动暂停。取值:展开详情

示例值:true枚举值:truefalse
ScaleRoNumMinstring

只读节点个数伸缩下限。取值范围:0~15。展开详情

示例值:2
ScaleRoNumMaxstring

只读节点个数伸缩上限。取值范围:0~15。展开详情

示例值:4
StorageTypestring

企业版存储类型取值如下:展开详情

示例值:PSL4参考取值来源:
    CreateStoragePlan
DBNodeNuminteger<int32>

标准版和企业版节点个数。取值如下:展开详情

示例值:1枚举值:
HotStandbyClusterstring

是否开启热备集群。取值范围如下:展开详情

示例值:ON枚举值:ONOFFSTANDBY3AZ参考取值来源:
    DescribeDBClusterAttribute
StrictConsistencystring

集群是否开启了多可用区数据强一致。取值范围如下:展开详情

示例值:ON枚举值:ONOFF
StandbyAZstring

存储热备集群的可用区。适用于标准版 3AZ 场景。展开详情

示例值:cn-hangzhou-g枚举值:
ProxyTypestring

数据库代理类型,取值范围如下:展开详情

示例值:Exclusive枚举值:
ProxyClassstring

标准版数据库代理规格。取值如下:展开详情

示例值:polar.maxscale.g2.medium.c枚举值:
LoosePolarLogBinstring

开启 Binlog 功能,取值范围如下:展开详情

示例值:ON枚举值:ONOFF
LooseXEnginestring

开启 X-Engine 存储引擎功能,取值范围如下:展开详情

示例值:ON枚举值:ONOFF
LooseXEngineUseMemoryPctstring

设置开启 X-Engine 存储引擎比例,取值范围 10~90 的整数。展开详情

示例值:50
StoragePayTypestring

存储计费类型。取值范围如下:展开详情

示例值:Prepaid枚举值:PostpaidPrepaid
StorageAutoScalestring

标准版集群是否开启存储自动扩容。取值范围如下:展开详情

示例值:Enable枚举值:EnableDisable
StorageUpperBoundinteger<int64>

设置标准版集群存储自动扩容上限,单位:GB。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:800取值 <= 64000
ProvisionedIopsinteger<int64>

ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。

展开详情
注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1000
BurstingEnabledstring

ESSD AutoPL 云盘是否开启 IO 性能突发。取值:展开详情

示例值:false枚举值:truefalse
TargetMinorVersionstring
StorageEncryptionboolean

是否开启云盘加密。取值范围如下:展开详情

StorageEncryptionKeystring

实例同地域内的云盘加密自定义密钥 ID。传入此参数表示自动开启云盘加密(开启后无法关闭)。若使用默认的服务密钥进行云盘加密请留空该参数。展开详情

返回参数

字段名称字段详情
DBClusterIdstring

集群 ID。

示例值:pc-bp1s826a1up******
OrderIdstring

订单 ID。

示例值:211454967******
RequestIdstring

请求 ID。

示例值:E56531A4-E552-40BA-9C58-137B80******
ResourceGroupIdstring

资源组 ID。

示例值:rg-***************

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidBackupRetentionPolicyOnClusterDeletion.Malformed
The specified BackupRetentionPolicyOnClusterDeletion is invalid.诊断
400
InvalidLowerCaseTableNames.Malformed
The specified LowerCaseTableNames is invalid.诊断
400
InvalidDefaultTimeZone.Malformed
The specified DefaultTimeZone is invalid.诊断
400
Location.FailedGetSubDomain
The specified regionId does not match the zoneId or the zoneId does not exist.诊断
400
MissParameter.GDNId
The GDNId parameter is required.诊断
400
EntityNotExist.ResourceGroup
The resource group does not exist..诊断

变更历史

变更时间变更内容概要操作
2025-02-17
变更请求参数DBNodeClass
2025-02-07
变更请求参数StorageSpace
2024-12-26
新增请求参数StorageEncryption
新增请求参数StorageEncryptionKey
2024-12-03
变更请求参数HotStandbyCluster
2024-11-28
新增请求参数TargetMinorVersion
2024-11-14
变更请求参数DBNodeNum
新增请求参数BurstingEnabled
2023-11-16
新增请求参数ProvisionedIops
2023-10-12
变更请求参数StorageSpace
变更请求参数StorageUpperBound
2024年08月20日