云原生数据库 PolarDB：CreateDBCluster - 创建集群

地域 ID。

可用区 ID。

CPU 架构。取值范围如下：

• X86
• ARM

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

• MySQL
• PostgreSQL
• Oracle

数据库引擎版本号。

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

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

• 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）克隆集群

• RecoverFromRecyclebin：从已释放的 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 或 RecoverFromRecyclebin 时，该参数必填。

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

• 若 CreationOption 为 RecoverFromRecyclebin，您需要为本参数传入已释放的源 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

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

• ESSDPL0
• ESSDPL1
• ESSDPL2
• ESSDPL3
• ESSDAUTOPL

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

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

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

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

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

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

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

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

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

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