CreateDBCluster

The operation that you want to perform. Set the value to CreateDBCluster.

The specification of the node. For more information, see Specifications of compute nodes.

The type of the database engine. Valid values:

• MySQL
• PostgreSQL
• Oracle

The version number of the database engine. Valid values:

• MySQL:
  • 5.6
  • 5.7
  • 8.0
• PostgreSQL: 11.
• Oracle: 11.

The billing method. Valid values:

• Postpaid: the pay-as-you-go billing method.
• Prepaid: the subscription billing method.

The ID of the region.

The ID of the zone.

The network type of the cluster. Only virtual private clouds (VPCs) are supported. Set the value to VPC.

The name of the cluster. The name must meet the following requirements:

• The name cannot start with http:// or https://.
• The name must be 2 to 256 characters in length.

Specifies whether to enable automatic renewal. Valid values:

• true: Automatic renewal is enabled.
• false: Automatic renewal is disabled.

The default value is false.

If PayType is set to Prepaid, this parameter is required. This parameter specifies whether the subscription is annual or monthly.

• Year: annual subscription.
• Month: monthly subscription.

• If Period is set to Month, UsedTime can be set to a value from 1 to 9.
• If Period is set to Month, UsedTime can be set to a value from 1 to 3.

The ID of the VPC.

The ID of the vSwitch.

The method that is used to create a cluster. Valid values:

• Normal: creates a new PolarDB cluster. For more information about how to perform this operation in the console, see the following topics:
  • Create a ApsaraDB PolarDB MySQL-compatible edition cluster
  • Create a ApsaraDB PolarDB PostgreSQL-compatible edition cluster
  • Create a ApsaraDB PolarDB O Edition cluster
• CloneFromPolarDB: clones data from an existing PolarDB cluster to a new PolarDB cluster. For more information about how to perform this operation in the console, see the following topics:
  • Restore data of a ApsaraDB PolarDB MySQL-compatible edition cluster
  • Restore data of a ApsaraDB PolarDB PostgreSQL-compatible edition cluster
  • Restore data of a ApsaraDB PolarDB O Edition cluster
• CloneFromRDS: clones data from an existing ApsaraDB RDS for MySQL instance to a new PolarDB cluster. For more information about how to perform this operation in the console, see Create a ApsaraDB PolarDB MySQL-compatible edition cluster by using the Clone from RDS method.
• MigrationFromRDS: migrates data from an existing ApsaraDB RDS for MySQL instance to a new PolarDB cluster. By default, the created PolarDB cluster is in read-only mode, and the binary logging feature is enabled. For more information about how to perform this operation in the console, see Create a ApsaraDB PolarDB MySQL-compatible edition cluster from an ApsaraDB RDS for MySQL instance.
• CreateGdnStandby: creates a secondary cluster. For more information about how to perform this operation in the console, see Add a secondary cluster.

The default value is Normal.

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.

• If CreationOption is set to MigrationFromRDS or CloneFromRDS, you must set this parameter to the ID of the source RDS instance. The source RDS instance is of the ApsaraDB RDS for MySQL 5.6 or 5.7 High-availability Edition, and storage is local SSD.
• If CreationOption is set to CloneFromPolarDB, you must set this parameter to the ID of the source PolarDB cluster. By default, the value of DBType of the destination cluster must be the same as that of the source cluster. For example, if a MySQL 8.0 cluster is used as the source cluster, you must set DBType to MySQL and DBVersion to 8.0 for the destination cluster.

The time point of data to be cloned. Valid values:

• LATEST: The data of the latest point in time is cloned.
• BackupID: Specify the ID of a backup set.

• Timestamp: Specify a point in time in the past. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

  The default value is LATEST.

The client token is used to ensure the idempotence of requests. A client token is generated in the client and is unique for different requests. The value is case-sensitive and can contain a maximum of 64 ASCII characters in length.

The ID of the resource group.

The whitelist of the PolarDB cluster.

Specifies whether to enable transparent data encryption (TDE). Valid values:

• true: enables TDE.
• false: disables TDE. This is the default value.

The ID of the global database network (GDN).

The edition of the PolarDB service. Valid values:

• Normal: Cluster Edition
• Basic: Single Node
• Archive: Archive Database

The time zone of the cluster. The time must be in UTC. Valid values:

• The default value is SYSTEM. By default, the time zone of the cluster is the same as that of the region where the cluster is deployed.
• You can set the parameter to a value that is on the hour from -12:00 to +13:00. For example, 00:00.

  Note This parameter takes effect only when DBType is set to MySQL.

Specifies whether the table name is case-sensitive. Valid values:

• 1: not case-sensitive.
• 0: case-sensitive.

The default value is 1.

The retention policy for the backup sets when you delete the cluster. Valid values:

• ALL: permanently retains all backups.
• LATEST: permanently retains the last backup. A backup is automatically created before you delete the cluster.
• NONE: does not retain backup sets after you delete the cluster.

The default value is NONE when you create the cluster. The system deletes all backup sets after you delete the cluster.

The minor version of the database engine.

• If DBVersion is set to 8.0, the valid values are:
  • 8.0.2
  • 8.0.1
• If DBVersion is set to 5.7, the value of this parameter is set to 5.7.28.
• If DBVersion is set to 5.6, the value of this parameter is set to 5.6.16.

The ID of the parameter template.

The ID of the cluster.

The ID of the order.

The ID of the request.

The ID of the resource group.