调用CreateDBCluster接口创建PolarDB集群。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDBCluster

系统规定参数。取值:CreateDBCluster

RegionId String cn-hangzhou

地域ID。

说明 您可以通过DescribeRegions接口查看可用地域。
ZoneId String cn-hangzhou-g

可用区ID。

说明 您可以通过DescribeRegions接口查看可选的可用区。
DBType String MySQL

数据库引擎类型,取值范围如下:

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String 5.6

数据库引擎版本号。

  • MySQL版本号取值范围如下:
    • 5.6
    • 5.7
    • 8.0
  • PostgreSQL版本号取值范围如下:
    • 11
    • 14
  • Oracle版本号取值为11
DBNodeClass String polar.mysql.x2.medium

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

说明 如需创建Serverless集群,请传入polar.mysql.sl.small
ClusterNetworkType String VPC

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

DBClusterDescription String test

集群名称,集群名称需满足如下要求:

  • 不能以http://https://开头。
  • 长度为2~256个字符。
PayType String Postpaid

付费类型,取值范围如下:

  • Postpaid:按量付费
  • Prepaid:预付费(包年包月)
AutoRenew Boolean true

是否自动续费,取值范围如下:

  • true:自动续费。
  • false:不自动续费。

默认为false

说明 当参数PayType取值为Prepaid时,该参数才生效。
Period String Month

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

  • Year:包年。即选择包年包月时,单位为年。
  • Month:包月。即选择包年包月时,单位为月。
UsedTime String 1
  • PeriodMonth时,UsedTime取值为整数类型,取值范围为[1-9]
  • PeriodYear时,UsedTime取值为整数类型,取值范围为[1-3]
VPCId String vpc-**********

专有网络ID。

VSwitchId String vsw-**********

虚拟交换机ID。

说明 如果已选择VPCId,则VSwitchId必选。
CreationOption String Normal

创建方式,取值范围如下:

默认为Normal

说明DBTypeMySQLDBVersion8.0时,本参数取值可以为CreateGdnStandby
SourceResourceId String rm-*************

源RDS实例ID或源PolarDB集群ID。仅当CreationOptionMigrationFromRDSCloneFromRDSCloneFromPolarDB时,该参数必填。

  • CreationOptionMigrationFromRDSCloneFromRDS,您需要为本参数传入源RDS实例ID。源RDS实例版本需为RDS MySQL 5.6 、5.7或8.0高可用版。
  • CreationOptionCloneFromPolarDB,您需要为本参数传入源PolarDB集群ID。克隆集群和源集群的DBType默认保持一致。例如源集群为MySQL 8.0,则克隆集群也需设置DBTypeMySQLDBVersion8.0
CloneDataPoint String LATEST

克隆数据的时间节点,取值:

  • LATEST:最新时间点的数据。
  • BackupID:历史备份集ID,请传入具体的备份集ID。
  • Timestamp:历史时间点,请传入具体的时间,格式:YYYY-MM-DDThh:mm:ssZ(UTC时间)。

    默认为LATEST

说明CreationOptionCloneFromRDS,则本参数取值只能为LATEST
ClientToken String 6000170000591aed949d0f5********************

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

ResourceGroupId String rg-************

资源组ID。

SecurityIPList String 10.***.***.***

PolarDB集群白名单IP地址。

说明 支持配置多个白名单IP地址,多个IP地址之间使用英文逗号分隔。
TDEStatus Boolean true

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

  • true:开启。
  • false:关闭(默认值)。
说明
  • 仅当DBTypePostgreSQLOracle时,本参数生效。
    说明
    • 您可以调用ModifyDBClusterTDE接口为PolarDB MySQL集群开启TDE加密。
      说明
      • TDE功能开启后不可关闭。
GDNId String gdn-***********

全球数据库网络ID。

说明CreationOptionCreateGdnStandby时,本参数必填。
CreationCategory String Normal

产品系列,取值范围如下:

  • Normal:集群版(默认值)
  • Basic:单节点
  • ArchiveNormal:高压缩引擎(X-Engine)
  • NormalMultimaster:多主架构集群版
  • SENormal:标准版
说明
  • 仅当DBTypeMySQL,且DBVersion5.65.78.0时,支持设置产品系列为Basic
    说明
    • 仅当DBTypeMySQL,且DBVersion8.0时,支持设置产品系列为ArchiveNormalNormalMultimaster
      说明
      • 仅当DBTypeMySQL,且DBMinorVersion8.0.1时,支持设置产品系列SENormal

      更多关产品系列的介绍,请参见于产品系列

DefaultTimeZone String SYSTEM

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

说明 仅当DBTypeMySQL时,该参数生效。
LowerCaseTableNames String 1

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

  • 1:不区分大小写
  • 0:区分大小写

默认取值为1

说明 仅当DBTypeMySQL时,该参数生效。
BackupRetentionPolicyOnClusterDeletion String NONE

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

  • ALL:永久保留全部备份。
  • LATEST:永久保留最后一个备份(删除前自动备份)。
  • NONE:集群删除时不保留备份集。

创建集群时,默认取值为NONE,即集群删除时不保留备份集。

说明
  • 仅当DBTypeMySQL时,该参数生效。
    说明
    • Serverless集群不支持该参数。
StorageSpace Long 50

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

说明 PolarDB MySQL标准版存储空间的取值范围:20~32000。
DBMinorVersion String 8.0.1

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

  • 8.0.2
  • 8.0.1
说明 当参数DBTypeMySQLDBVersion8.0时,该参数才生效。
ParameterGroupId String pcpg-**************

参数模板ID。

说明 您可以通过DescribeParameterGroups接口查看目标地域的参数模板列表,包括参数模板ID。
Tag.N.Key String type

标签键。若您需要为目标集群一次性添加多个标签,请单击添加增加标签键。

说明 每次最多添加20对标签,Tag.N.Key对应的值为Tag.N.Value
Tag.N.Value String test

标签值。若您需要为目标集群一次性添加多个标签,请单击添加增加标签值。

说明 每次最多添加20对标签,Tag.N.Value对应的值为Tag.N.Key
ServerlessType String AgileServerless

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

说明 仅Serverless集群支持该参数。
ScaleMin String 1

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

说明 仅Serverless集群支持该参数。
ScaleMax String 3

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

说明 仅Serverless集群支持该参数。
AllowShutDown String true

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

  • true:开启
  • false:关闭(默认)
    说明 仅Serverless集群支持该参数。
ScaleRoNumMin String 2

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

说明 仅Serverless集群支持该参数。
ScaleRoNumMax String 4

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

说明 仅Serverless集群支持该参数。
StorageType String PSL4

企业版存储类型取值如下:

  • PSL5
  • PSL4

标准版存储类型取值如下:

  • ESSDPL1
  • ESSDPL2
  • ESSDPL3
    说明 Serverless集群不支持该参数。
DBNodeNum Integer 1

集群节点个数。取值如下:

  • 1:表示只有1个读写节点。
  • 2:表示有1个只读节点和一个读写节点。
说明
  • 企业版默认为2个节点,标准版默认为1个节点。
  • 仅PolarDB MySQL版支持该参数。
HotStandbyCluster String ON

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

  • ON(默认):开启热备集群。
  • OFF:关闭热备集群。
  • STANDBY:标准版开启热备集群。
    说明 标准版集群的默认值为STANDBY
StrictConsistency String ON

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

  • ON:表示开启了多可用区数据强一致,适用于标准版3AZ场景。
  • OFF:表示未开启多可用区数据强一致。
StandbyAZ String cn-hangzhou-g

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

说明 开启了多可用区数据强一致,该参数才生效。
ProxyType String Exclusive

数据库代理类型,取值范围如下:

  • OFF(默认):关闭数据库代理。
  • EXCLUSIVE:企业独享版
  • GENERAL:企业通用版
ProxyClass String polar.maxscale.g2.medium.c

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

  • polar.maxscale.g2.medium.c:2核。
  • polar.maxscale.g2.large.c:4核。
  • polar.maxscale.g2.xlarge.c:8核。
  • polar.maxscale.g2.2xlarge.c:16核。
  • polar.maxscale.g2.3xlarge.c:24核。
  • polar.maxscale.g2.4xlarge.c:32核。
  • polar.maxscale.g2.8xlarge.c:64核。
LoosePolarLogBin String ON

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

  • ON:集群开启Binlog功能
  • OFF:集群关闭Binlog功能
    说明 当参数DBTypeMySQL时,该参数才生效。
LooseXEngine String ON

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

  • ON:集群开启X-Engine引擎
  • OFF:集群关闭X-Engine引擎
    说明 当参数CreationOption不等于CreateGdnStandbyDBTypeMySQLDBVersion8.0时,该参数才生效。开启X-Engine引擎的节点内存规格必须大于等于16 GB。
LooseXEngineUseMemoryPct String 50

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

说明 当参数LooseXEngineON时,该参数才生效。

返回数据

名称 类型 示例值 描述
RequestId String E56531A4-E552-40BA-9C58-137B80******

请求ID。

ResourceGroupId String rg-***************

资源组ID。

DBClusterId String pc-bp1s826a1up******

集群ID。

OrderId String 211454967******

订单ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=CreateDBCluster
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-g
&DBType=MySQL
&DBVersion=5.6
&DBNodeClass=polar.mysql.x2.medium
&ClusterNetworkType=VPC
&DBClusterDescription=test
&PayType=Postpaid
&AutoRenew=true
&Period=Month
&UsedTime=1
&VPCId=vpc-**********
&VSwitchId=vsw-**********
&CreationOption=Normal
&SourceResourceId=rm-*************
&CloneDataPoint=LATEST
&ClientToken=6000170000591aed949d0f5********************
&ResourceGroupId=rg-************
&SecurityIPList=10.***.***.***
&TDEStatus=true
&GDNId= gdn-***********
&CreationCategory=Normal
&DefaultTimeZone=SYSTEM
&LowerCaseTableNames=1
&BackupRetentionPolicyOnClusterDeletion=NONE
&StorageSpace=50
&DBMinorVersion=8.0.1
&ParameterGroupId=pcpg-**************
&Tag=[{"Key":"type","Value":"test"}]
&ServerlessType=AgileServerless
&ScaleMin=1
&ScaleMax=3
&AllowShutDown=true
&ScaleRoNumMin=2
&ScaleRoNumMax=4
&StorageType=PSL4
&DBNodeNum=1
&HotStandbyCluster=ON
&ProxyType=Exclusive
&ProxyClass=polar.maxscale.g2.medium.c
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDBClusterResponse>
    <RequestId>E56531A4-E552-40BA-9C58-137B80******</RequestId>
    <ResourceGroupId>rg-***************</ResourceGroupId>
    <DBClusterId>pc-bp1s826a1up******</DBClusterId>
    <OrderId>211454967******</OrderId>
</CreateDBClusterResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E56531A4-E552-40BA-9C58-137B80******",
  "ResourceGroupId" : "rg-***************",
  "DBClusterId" : "pc-bp1s826a1up******",
  "OrderId" : "211454967******"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidBackupRetentionPolicyOnClusterDeletion.Malformed The specified BackupRetentionPolicyOnClusterDeletion is invalid. 当前删除(释放)集群时的保留备份策略( BackupRetentionPolicyOnClusterDeletion)无效。
400 InvalidLowerCaseTableNames.Malformed The specified LowerCaseTableNames is invalid. 指定的表名是否区分大小写参数(LowerCaseTableNames)无效。
400 InvalidDefaultTimeZone.Malformed The specified DefaultTimeZone is invalid. 指定的默认时区参数(DefaultTimeZone)无效。
400 Location.FailedGetSubDomain The specified regionId does not match the zoneId or the zoneId does not exist. 指定的地域ID与可用区ID不匹配或者可用区ID不存在。
400 InvalidLowerCaseTableNames.Malformed The specified LowerCaseTableNames value is invalid. 指定的小写字母名称无效。
400 MissParameter.GDNId The GDNId parameter is required. 需要指定的GDNId。

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