调用CreateDBCluster接口创建PolarDB集群。

调试

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

请求参数

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

系统规定参数，取值为CreateDBCluster。

DBNodeClass String 是 polar.mysql.x2.medium

节点规格，详情请参见计算节点规格。

DBType String 是 MySQL

数据库引擎类型，取值范围如下：

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String 是 5.6

数据库引擎版本号。

  • MySQL版本号取值范围如下：
    • 5.6
    • 5.7
    • 8.0
  • PostgreSQL版本号取值为11。
  • Oracle版本号取值为11。
PayType String 是 Postpaid

付费类型，取值范围如下：

  • Postpaid：按量付费
  • Prepaid：预付费（包年包月）
RegionId String 是 cn-hangzhou

地域ID。

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

可用区ID。

说明 您可以通过DescribeRegions接口查看可选的可用区。
ClusterNetworkType String 否 VPC

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

DBClusterDescription String 否 test

集群名称，集群名称需满足如下要求：

  • 不能以http://或https://开头。
  • 长度为2~256个字符。
AutoRenew Boolean 否 true

是否自动续费，取值范围如下：

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

默认为false。

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

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

  • Year：包年。
  • Month：包月。
UsedTime String 否 1
  • 当Period为Month时，UsedTime取值为[1-9]。
  • 当Period为Year时，UsedTime取值为[1-3]。
VPCId String 否 vpc-**********

专有网络ID。
VSwitchId String 否 vsw-**********

虚拟交换机ID。
CreationOption String 否 Normal

创建方式，取值范围如下：

默认为Normal。

说明
  • 当DBType为MySQL且DBVersion为5.6或5.7时，本参数取值可以为CloneFromRDS或MigrationFromRDS。
  • 当DBType为MySQL且DBVersion为8.0时，本参数取值可以为 CreateGdnStandby。
SourceResourceId String 否 rm-*************

源RDS实例ID或源PolarDB集群ID。仅当CreationOption为MigrationFromRDS、CloneFromRDS或CloneFromPolarDB时，该参数必填。

  • 若CreationOption为MigrationFromRDS或CloneFromRDS，您需要为本参数传入源RDS实例ID。源RDS实例版本需为RDS MySQL 5.6 或5.7 高可用版，且存储类型为本地SSD盘。
  • 若CreationOption为CloneFromPolarDB，您需要为本参数传入源PolarDB集群ID。克隆集群和源集群的DBType默认保持一致。例如源集群为MySQL 8.0，则克隆集群也需设置DBType为MySQL且DBVersion为8.0。
CloneDataPoint String 否 LATEST

克隆数据的时间节点，取值：

  • LATEST：最新时间点的数据。
  • BackupID：历史备份集ID，请传入具体的备份集ID。

  • Timestamp：历史时间点，请传入具体的时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    默认为LATEST。

说明 若CreationOption为CloneFromRDS，则本参数取值只能为LATEST。
ClientToken String 否 6000170000591aed949d0f5********************

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

资源组ID。
SecurityIPList String 否 10.***.***.***

PolarDB集群白名单。
TDEStatus Boolean 否 true

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

  • true：开启。
  • false：关闭（默认值）。
说明
  • 仅当DBType为PostgreSQL或Oracle时，本参数生效。
  • 您可以调用ModifyDBClusterTDE接口为PolarDB MySQL集群开启TDE加密。
  • TDE功能开启后不可关闭。
GDNId String 否 gdn-***********

全球数据库网络ID。

说明 当CreationOption为CreateGdnStandby时，本参数必填。
CreationCategory String 否 Normal

产品系列，取值范围如下：

  • Normal：集群版
  • Basic：单节点
  • Archive：历史库
说明
  • 仅当DBType为MySQL，且DBVersion为5.6、5.7或8.0时，支持设置产品系列为Basic。
  • 仅当DBType为MySQL，且DBVersion为8.0时，支持设置产品系列为Archive。

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

DefaultTimeZone String 否 SYSTEM

集群时区（UTC），取值范围如下：

  • 默认取值为SYSTEM，默认时区与Region所在时区一致。
  • 可选取值范围为-12:00~+13:00内的所有整点时间，如00:00。
    说明 仅当DBType为MySQL时，该参数生效。
LowerCaseTableNames String 否 1

表名是否区分大小写，取值范围如下：

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

默认取值为1。

说明 仅当DBType为MySQL时，该参数生效。
BackupRetentionPolicyOnClusterDeletion String 否 NONE

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

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

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

说明 仅当DBType为MySQL时，该参数生效。
DBMinorVersion String 否 8.0.1

数据库引擎小版本号。

  • 当DBVersion为8.0时，取值范围如下：
    • 8.0.2
    • 8.0.1
  • 当DBVersion为5.7时，取值为5.7.28。
  • 当DBVersion为5.6时，取值为5.6.16。
ParameterGroupId String 否 pcpg-**************

参数模板ID。

说明 您可以通过DescribeParameterGroups接口目标集群下所有参数目标的详细信息，包括参数模板ID。

返回数据

名称 类型 示例值 描述
DBClusterId String pc-****************

集群ID。
OrderId String 111111111111111

订单ID。
RequestId String E56531A4-E552-40BA-9C58-137B80******

请求ID。
ResourceGroupId String rg-***************

资源组ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=CreateDBCluster
&DBNodeClass=polar.mysql.x2.medium
&DBType=MySQL
&DBVersion=5.6
&PayType=Postpaid
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

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

JSON格式 

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

错误码

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 无效

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