PolarDB:CreateDBCluster

Region ID.

Availability Zone ID.

CPU architecture. Available values include:

• X86
• ARM

Database engine type, with available values as follows:

• MySQL
• PostgreSQL
• Oracle

Database engine version number.

• For MySQL, the version numbers are as follows:
  • 5.6
  • 5.7
  • 8.0
• For PostgreSQL, the version numbers are as follows:
  • 11
  • 14
  • 15
• For Oracle, the version numbers are as follows:
  • 11
  • 14

Node specifications. For details, refer to the following documents:

• PolarDB MySQL Edition: Compute Node Specifications.
• PolarDB PostgreSQL Edition (Oracle Compatible): Compute Node Specifications.
• PolarDB PostgreSQL Edition: Compute Node Specifications.

Cluster network type, currently only VPC is supported, with a fixed value of VPC.

Cluster name, which must meet the following requirements:

• Cannot start with http:// or https://.
• Length should be between 2 and 256 characters.

Payment type, with available values as follows:

• Postpaid: Pay-as-you-go.
• Prepaid: Subscription (monthly or yearly).

Whether to enable auto-renewal, with available values as follows:

• true: Auto-renew.
• false: Do not auto-renew.

The default is false.

If the payment type is Prepaid, this parameter is required. It specifies whether the prepaid cluster is on a monthly or yearly basis.

• Year: Yearly subscription.
• Month: Monthly subscription.

If the payment type is Prepaid, this parameter is required.

• When Period is Month, UsedTime should be an integer within [1-9].
• When Period is Year, UsedTime should be an integer within [1-3].

VPC ID.

Virtual switch ID.

Creation method, with the following values supported:

• Normal: Creates a brand new PolarDB cluster. For console operations, refer to the following documents:

  • Create a PolarDB MySQL Edition Database Cluster
  • Create a PolarDB PostgreSQL Edition Database Cluster
  • Create a PolarDB PostgreSQL Edition (Oracle Compatible) Database Cluster

• CloneFromPolarDB: Clones data from an existing PolarDB cluster to a new PolarDB cluster. For console operations, refer to the following documents:

  • Clone a PolarDB MySQL Edition Cluster
  • Clone a PolarDB PostgreSQL Edition Cluster
  • Clone a PolarDB PostgreSQL Edition (Oracle Compatible) Cluster

• RecoverFromRecyclebin: Recovers data from a released PolarDB cluster to a new PolarDB cluster. For console operations, refer to the following documents:

  • Restore a Released PolarDB MySQL Edition Cluster
  • Restore a Released PolarDB PostgreSQL Edition Cluster
  • Restore a Released PolarDB PostgreSQL Edition (Oracle Compatible) Cluster

• CloneFromRDS: Clones data from an existing RDS instance to a new PolarDB cluster. Console operation guide is available at One-click Clone from RDS MySQL to PolarDB MySQL Edition.

• MigrationFromRDS: Migrates data from an existing RDS instance to a new PolarDB cluster. The created PolarDB cluster operates in read-only mode with Binlog enabled by default. Console operation guide is at One-click Upgrade from RDS MySQL to PolarDB MySQL Edition.

• CreateGdnStandby: Creates a standby cluster. Console operation guide can be found at Add Standby Cluster.

• UpgradeFromPolarDB: Upgrades and migrates from PolarDB. Console operation guide is detailed in Major Version Upgrade.

The default value is Normal.

Source RDS instance ID or source PolarDB cluster ID. This parameter is mandatory only when CreationOption is set to MigrationFromRDS, CloneFromRDS, CloneFromPolarDB, or RecoverFromRecyclebin.

• If CreationOption is MigrationFromRDS or CloneFromRDS, you need to input the source RDS instance ID. The source RDS instance version must be RDS MySQL 5.6, 5.7, or 8.0 High Availability edition.

• If CreationOption is CloneFromPolarDB, you need to input the source PolarDB cluster ID. The DBType of the cloned cluster will default to match the source cluster. For example, if the source cluster is MySQL 8.0, the cloned cluster must also have DBType set to MySQL and DBVersion to 8.0.

• If CreationOption is RecoverFromRecyclebin, you need to input the released source PolarDB cluster ID. The DBType of the cluster being recovered from the recycle bin must match the source cluster. For example, if the source cluster was MySQL 8.0, the recovered cluster must also have DBType set to MySQL and DBVersion to 8.0.

The point in time to clone data, with the following options:

• LATEST: Data from the latest time point.
• BackupID: Historical backup set ID, please enter the specific backup set ID.
• Timestamp: Historical time point, please enter the specific time in the format YYYY-MM-DDThh:mm:ssZ (UTC time).

The default value is LATEST.

Used to ensure idempotency of the request. Generated by the client, ensuring uniqueness across different requests, case-sensitive, and not exceeding 64 ASCII characters.

Resource group ID.

PolarDB cluster whitelist IP address.

Enables TDE encryption. Valid values are as follows:

• true: Enabled.
• false: Disabled (default).

Global Database Network (GDN) ID.

Product series, with valid values as follows:

• Normal: Cluster Edition (default)
• Basic: Single-node
• ArchiveNormal: High Compression Engine (X-Engine)
• NormalMultimaster: Multi-master Cluster Edition
• SENormal: Standard Edition

For more information about product series, see Product Series.

Cluster timezone (UTC), with selectable values ranging from -12:00 to +13:00 at whole-hour intervals, e.g., 00:00. The default value is SYSTEM, which matches the Region's timezone.

Whether table names are case-sensitive, with valid values as follows:

• 1: Case-insensitive
• 0: Case-sensitive

The default value is 1.

Backup retention policy upon cluster deletion, with valid values as follows:

• ALL: Permanently retain all backups.
• LATEST: Permanently retain the latest backup (automatically backed up before deletion).
• NONE: Do not retain backup sets upon cluster deletion.

By default, the value is set to NONE, indicating no backup sets are retained upon cluster deletion.

Storage space for pay-by-space (subscription) billing. Unit: GB.

Database engine minor version number. Valid values include:

• 8.0.2
• 8.0.1

Parameter template ID.

List of tags.

Serverless type. The current value is fixed to AgileServerless (sensitive mode).

Minimum scaling limit for a single node. The value range is: 1 PCU~31 PCU.

Maximum scaling limit for a single node. The value range is: 1 PCU~32 PCU.

Whether to enable idle pause. Values:

• true: Enabled

• false: Disabled (default)

Minimum scaling limit for the number of read-only nodes. The value range is: 0~15.

Maximum scaling limit for the number of read-only nodes. The value range is: 0~15.

Enterprise edition storage types include:

• PSL5
• PSL4

Standard edition storage types include:

• ESSDPL0
• ESSDPL1
• ESSDPL2
• ESSDPL3
• ESSDAUTOPL

The number of nodes. This parameter is supported for Standard Edition clusters. Valid values:

• 1 (default): only one primary node.
• 2: one read-only node and one primary node.

• By default, an Enterprise Edition cluster has two nodes and a Standard Edition cluster has one node.

• This parameter is supported only for PolarDB for MySQL clusters.

Whether to enable the hot standby cluster. Values are as follows:

• ON (default): Enables the hot standby cluster.
• OFF: Disables the hot standby cluster.
• STANDBY: Enables the hot standby cluster for the standard edition.

Whether the cluster has enabled strong data consistency across multiple zones. Values are as follows:

• ON: Indicates strong data consistency across multiple zones is enabled, applicable to the standard edition 3AZ scenario.

• OFF: Indicates strong data consistency across multiple zones is not enabled.

The availability zone where the hot standby cluster is stored. Applicable to the standard edition 3AZ scenario.

Database proxy type, with values including:

• EXCLUSIVE: Enterprise Exclusive Edition
• GENERAL: Enterprise General Purpose Edition

Standard edition database proxy specifications. Values are as follows:

• polar.maxscale.g2.medium.c: 2 cores.
• polar.maxscale.g2.large.c: 4 cores.
• polar.maxscale.g2.xlarge.c: 8 cores.
• polar.maxscale.g2.2xlarge.c: 16 cores.
• polar.maxscale.g2.3xlarge.c: 24 cores.
• polar.maxscale.g2.4xlarge.c: 32 cores.
• polar.maxscale.g2.8xlarge.c: 64 cores.

Enable Binlog feature, valid values are as follows:

• ON: Cluster enables the Binlog feature. - OFF: Cluster disables the Binlog feature. > This parameter takes effect only when the DBType parameter is set to MySQL.

Enable the X-Engine storage engine feature, with valid values as follows:

• ON: The cluster enables the X-Engine engine.
• OFF: The cluster disables the X-Engine engine.

Set the ratio for enabling the X-Engine storage engine, with a range of integers from 10 to 90.

The storage billing type, with valid values as follows:

• Postpaid: Pay-as-you-go (hourly).
• Prepaid: Pay-per-use based on space (subscription).

Whether to enable automatic storage expansion for standard edition clusters, with valid values as follows:

• Enable: Enables automatic storage expansion.
• Disable: Disables automatic storage expansion.

Set the upper limit for automatic storage expansion of standard edition clusters, in GB.

The provisioned read and write IOPS for ESSD AutoPL cloud disks. Possible values: 0 to min{50,000, 1000*capacity-Baseline Performance}.

Baseline Performance = min{1,800+50*capacity, 50000}.