CreateDBCluster

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

The specification of the node. For more information, see Specifications and pricing.

The type of the database engine. Valid values:

• MySQL
• PostgreSQL
• Oracle

The version number of the database engine. Valid values:

• The version number range of MySQL:
  • 5.6
  • 5.7
  • 8.0
• The version number of PostgreSQL: 11
• The version number of Oracle: 11

The payment type. Valid values:

• Postpaid: pay-as-you-go
• Prepaid: subscription

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 auto-renewal. Valid values:

• true: Enable auto-renewal.
• false: Disable auto-renewal.

Default value: false

If the payment type is Prepaid, this parameter is required. This parameter specifies whether the subscription type of the cluster is monthly subscription or annual subscription.

• Year: annual subscription
• Month: monthly subscription

• If Period is set to Month, the valid values of the UsedTime parameter range from 1 to 9.
• If Period is set to Year, the valid values of the UsedTime parameter range 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 PolarDB for MySQL cluster
  • Create a PolarDB for PostgreSQL cluster
  • Create a PolarDB-O 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 PolarDB for MySQL cluster
  • Restore data of a PolarDB for PostgreSQL cluster
  • Restore data of a PolarDB-O 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 PolarDB for MySQL cluster by using the Clone from RDS method.
• MigrationFromRDS: migrates data from an existing ApsaraDB RDS for MySQL instance to a new PolarDB cluster. The created PolarDB cluster is in read-only mode. By default, binary logging is enabled. For more information about how to perform this operation in the console, see Create a PolarDB for MySQL cluster by using the Migration from RDS method.
• CreateGdnStandby: creates a secondary cluster. For more information about how to perform this operation in the console, see Add Secondary Cluster.

Default value: Normal

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

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

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

• LATEST: data of the latest time point.
• BackupID: ID of the historical backup set. Specify the ID of the specific backup set.

• Timestamp: historical time point. Specify the specific time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

  Default value: LATEST

The client token that is used to ensure the idempotence of the request. You can use the client to generate the parameter value, but you must make sure that the parameter value is unique among different requests. The parameter 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: Enable TDE.
• false: Disable TDE. This value is the default value.

The ID of the global database network (GDN).

The product edition. 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:

• Default value: SYSTEM. By default, the time zone of the cluster is consistent with that of the region.
• You can select the time on the hour from -12:00 to +13:00, such as 00:00.

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

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

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

Default value: 1

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

• ALL: permanently retains all the backups.
• LATEST: permanently retains the last backup. A backup is automatically created before the cluster is deleted.
• NONE: retains no backup sets when you delete the cluster.

The default value is NONE when you create the cluster. The default value NONE indicates that no backup sets are retained when the cluster is deleted.

The ID of the cluster.

The ID of the order.

The ID of the request.

The ID of the resource group.