CreateDBCluster - 创建集群

地域ID。

可用区ID。

CPU 架构。取值范围：

• X86
• ARM

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

• MySQL
• PostgreSQL
• Oracle

数据库引擎版本号。

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

节点规格，详情请参见如下文档：

• PolarDB MySQL版：计算节点规格。
• PolarDB PostgreSQL版（兼容Oracle）：计算节点规格。
• PolarDB PostgreSQL版：计算节点规格。

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

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

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

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

• Postpaid：按量付费
• Prepaid：预付费（包年包月）

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

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

默认为false。

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

• Year：包年。即选择包年包月时，单位为年。
• Month：包月。即选择包年包月时，单位为月。

若付费类型为Prepaid时，该参数为必传参数。

• 当Period为Month时，UsedTime取值为整数类型，取值范围为[1-9]。
• 当Period为Year时，UsedTime取值为整数类型，取值范围为[1-3]。

专有网络ID。

虚拟交换机ID。

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

• Normal：创建一个全新的PolarDB集群，控制台操作请参见如下文档：

  • 创建PolarDB MySQL版数据库集群
  • 创建PolarDB PostgreSQL版数据库集群
  • 创建PolarDB PostgreSQL版（兼容Oracle）数据库集群

• CloneFromPolarDB：从现有PolarDB集群克隆数据到新的PolarDB集群，控制台操作请参见如下文档：

  • PolarDB MySQL版克隆集群
  • PolarDB PostgreSQL版克隆集群
  • PolarDB PostgreSQL版（兼容Oracle）克隆集群

• CloneFromRDS：从现有RDS实例克隆数据到新的PolarDB集群，控制台操作请参见一键克隆RDS MySQL到PolarDB MySQL版；

• MigrationFromRDS：从现有RDS实例迁移数据到新的PolarDB集群。创建的PolarDB集群是只读模式，且默认开启Binlog。控制台操作请参见一键升级RDS MySQL到PolarDB MySQL版。

• CreateGdnStandby：创建一个从集群，控制台操作请参见添加从集群。

• UpgradeFromPolarDB：从PolarDB升级迁移，控制台操作请参见大版本升级。

默认为Normal。

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

• 若CreationOption为MigrationFromRDS或CloneFromRDS，您需要为本参数传入源RDS实例ID。源RDS实例版本需为RDS MySQL 5.6 、5.7或8.0高可用版。

• 若CreationOption为CloneFromPolarDB，您需要为本参数传入源PolarDB集群ID。克隆集群和源集群的DBType默认保持一致。例如源集群为MySQL 8.0，则克隆集群也需设置DBType为MySQL且DBVersion为8.0。

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

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

默认为LATEST。

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

资源组ID。

PolarDB集群白名单IP地址。

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

• true：开启。
• false：关闭（默认值）。

全球数据库网络ID。

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

• Normal：集群版（默认值）
• Basic：单节点
• ArchiveNormal：高压缩引擎（X-Engine）
• NormalMultimaster：多主架构集群版
• SENormal：标准版

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

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

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

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

默认取值为1。

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

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

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

按空间计费（包年包月）的存储空间。单位：GB。

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

• 8.0.2

• 8.0.1

参数模板ID。

标签列表。

Serverless类型。当前取值固定为AgileServerless（敏态）。

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

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

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

• true：开启

• false：关闭（默认）

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

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

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

• PSL5
• PSL4

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

• ESSDPL1
• ESSDPL2
• ESSDPL3
• ESSDAUTOPL

标准版节点个数。取值如下：

• 1（默认）：表示只有1个读写节点。
• 2：表示有1个只读节点和1个读写节点。

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

• ON（默认）：开启热备集群。
• OFF：关闭热备集群。
• STANDBY：标准版开启热备集群。

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

• ON：表示开启了多可用区数据强一致，适用于标准版3AZ场景。

• OFF：表示未开启多可用区数据强一致。

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

数据库代理类型，取值范围如下：

• OFF（默认）：关闭数据库代理。
• EXCLUSIVE：企业独享版
• GENERAL：企业通用版

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

• 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核。

开启Binlog功能，取值范围如下：

• ON：集群开启Binlog功能
• OFF：集群关闭Binlog功能

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

• ON：集群开启X-Engine引擎
• OFF：集群关闭X-Engine引擎

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

存储计费类型。取值范围如下：

• Postpaid：按容量计费（按量付费）。
• Prepaid：按空间计费（包年包月）。

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

• Enable：开启存储自动扩容。
• Disable：关闭存储自动扩容。

设置标准版集群存储自动扩容上限，单位：GB。

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

基准性能=min{1,800+50*容量, 50000}。