ApsaraDB RDS:CreateDBInstance

The region ID. You can call DescribeRegions to query available regions.

The database engine. Valid values:

• MySQL

• SQLServer

• PostgreSQL

• MariaDB

The database engine version. Valid values:

• Regular instances

  • MySQL: 5.5, 5.6, 5.7, 8.0

  • SQL Server: 08r2_ent_ha (cloud disk edition, discontinued), 2008r2 (Premium Local SSDs, discontinued), 2012 (Enterprise Edition Basic), 2012_ent_ha, 2012_std_ha, 2012_web, 2014_ent_ha, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_ent, 2017_std_ha, 2017_web, 2019_ent, 2019_std_ha, 2019_web, 2022_ent, 2022_std_ha, 2022_web, 2025_ent, 2025_std

  • PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0, 17.0, 18.0

  • MariaDB: 10.3, 10.6

• Serverless instances

  • MySQL: 5.7, 8.0

  • SQL Server: 2016_std_sl, 2017_std_sl, 2019_std_sl

  • PostgreSQL: 14.0, 15.0, 16.0, 17.0, 18.0

The instance type. You can specify a standard or YiTian instance type. For details, see Primary instance types.

To create a Serverless instance, specify one of the following values:

• MySQL Basic Edition: mysql.n2.serverless.1c

• MySQL High-Availability Edition: mysql.n2.serverless.2c

• SQL Server: mssql.mem2.serverless.s2

• PostgreSQL Basic Edition: pg.n2.serverless.1c

• PostgreSQL High-Availability Edition: pg.n2.serverless.2c

The instance storage capacity. Unit: GB. The value is incremented in 5 GB increments. For the value range, see Primary instance types.

A deprecated parameter. You do not need to configure this parameter.

The network connectivity type of the instance. Set the value to Intranet, which specifies an internal network connection.

The instance name. The name must be 2 to 255 characters in length and can contain letters, digits, Chinese characters, and hyphens (-). It must start with a letter or a Chinese character.

The IP address whitelist of the instance. Separate multiple entries with commas (,). Entries cannot be duplicated. You can add up to 1,000 IP addresses or CIDR blocks for a single instance. The following two formats are supported:

• IP address format, such as 10.10.XX.XX.

• CIDR format, such as 10.10.XX.XX/24 (classless inter-domain routing, where 24 indicates the prefix length, ranging from 1 to 32).

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

The billing method of the instance. Valid values:

• Postpaid: pay-as-you-go.

• Prepaid: subscription.

• Serverless: Serverless billing. This value is not supported for MariaDB instances. For more information, see Introduction to MySQL Serverless instances, Introduction to SQL Server Serverless instances, and Introduction to PostgreSQL Serverless instances.

The zone ID of the primary node.

• If you specify a VPC and a vSwitch, you must specify the zone ID of the vSwitch. Otherwise, the instance cannot be created.

• For High-Availability Edition instances, you must also specify ZoneIdSlave1 to determine whether the instance uses single-zone or multi-zone deployment.

• For RDS Enterprise Edition instances, you must also specify ZoneIdSlave1 and ZoneIdSlave2 to determine whether the instance uses single-zone or multi-zone deployment.

• For RDS Cluster Edition instances, you must also specify ZoneIdSlave1 for two-node clusters, and ZoneIdSlave1 and ZoneIdSlave2 for three-node clusters.

The zone ID of the secondary node.

• If you set this parameter to Auto, the system automatically selects a zone for the secondary node in a multi-zone deployment.

• If this parameter is set to the same value as ZoneId, the instance uses single-zone deployment.

• If this parameter is set to a value different from ZoneId, the instance uses multi-zone deployment.

RDS MySQL Cluster Edition instances support creating one or two secondary nodes when you create an instance. You can use this parameter to specify the zone ID of the second secondary node.

The network type of the instance. Valid values:

• VPC: virtual private cloud.

• Classic: classic network.

The access mode of the instance. Valid values:

• Standard: standard mode.

• Safe: database proxy mode.

Default value: allocated by the RDS system.

The VPC ID.

The vSwitch ID.

• Zone mapping: The zone of the vSwitch must correspond to the primary node zone (ZoneId) and the secondary node zone (ZoneIdSlave1). If you specify two vSwitch IDs, their order must match the order of ZoneId and ZoneSlaveId1.

• Network type restriction: InstanceNetworkType must be set to VPC.

• Multiple vSwitch requirement: If you specify ZoneSlaveId1 (secondary node zone ID) and it is not set to Auto, you must specify two vSwitch IDs separated by a comma (,).

• Character restriction: The vSwitch ID cannot contain special characters such as spaces, !, #, ￥, &, or %.

The internal IP address of the instance. The IP address must be within the IP address range of the specified vSwitch. The system automatically assigns an internal IP address based on the values of VPCId and vSwitchId.

The subscription duration. Valid values:

• If Period is set to Year, the valid values of UsedTime are 1 to 5.

• If Period is set to Month, the valid values of UsedTime are 1 to 11.

The unit of the subscription duration. Valid values:

• Year

• Month

The resource group ID.

The instance storage type. Valid values:

• local_ssd: Premium Local SSDs (recommended).

• general_essd: Premium ESSD (recommended).

• cloud_essd: PL1 ESSD.

• cloud_essd2: PL2 ESSD.

• cloud_essd3: PL3 ESSD.

• cloud_ssd: standard SSD (not recommended, discontinued in some regions).

The default value of this parameter is determined by the instance type specified in the DBInstanceClass parameter:

• If the instance type is for Premium Local SSDs, the default value is local_ssd.

• If the instance type is for cloud disks, the default value is cloud_essd.

The business extension parameter.

The ID of the cloud disk encryption key in the same region. If you specify this parameter, cloud disk encryption is enabled and cannot be disabled. You must also specify RoleARN.

You can view the key ID in the Key Management Service (KMS) console or create a key. For more information, see Create a key.

The global resource descriptor (ARN) that is used for the authorization of the primary account to allow the RDS cloud service account to access KMS. You can call the CheckCloudResourceAuthorized operation to query the ARN.

Specifies whether to enable auto-renewal for the instance. This parameter is valid only for subscription instances. Valid values:

• true

• false

The instance edition. Valid values:

• Regular instances

  • Basic: Basic Edition.

  • HighAvailability: High-Availability Edition.

  • cluster: MySQL or PostgreSQL Cluster Edition.

  • AlwaysOn: SQL Server Cluster Edition.

  • Finance: RDS Enterprise Edition.

  Note

  This parameter is required when you create an SQL Server Enterprise Cluster Edition instance, or a Basic Edition Enterprise instance. For example, to create a Basic Edition 2022 Enterprise Cluster Edition (2022_ent) instance, you must set this parameter to Basic.

• Serverless instances

  • serverless_basic: Serverless Basic Edition. (Applicable to MySQL and PostgreSQL only)

  • serverless_standard: Serverless High-Availability Edition. (Applicable to MySQL and PostgreSQL only)

  • serverless_ha: SQL Server Serverless High-Availability Edition.

  Note

  This parameter is required when PayType is set to Serverless.

The dedicated cluster host group ID.

This parameter is required when you create an ApsaraDB RDS instance in a dedicated cluster.

• You can call the DescribeDedicatedHostGroups operation to query the RDS host group information.

• If you have not created an RDS host group, you can call the CreateDedicatedHostGroup operation to create one.

The host ID of the primary instance in the dedicated cluster.

This parameter is required when you create an ApsaraDB RDS instance in a dedicated cluster. If you do not specify this parameter, the system automatically assigns a host.

• You can call the DescribeDedicatedHosts operation to query the host information in the RDS host group.

• If you do not have a host, you can call the CreateDedicatedHost operation to add one.

The host ID of the secondary instance in the dedicated cluster.

This parameter is required when you create an ApsaraDB RDS High-Availability Edition or RDS Enterprise Edition instance in a dedicated cluster. If you do not specify this parameter, the system automatically assigns a host.

• You can call the DescribeDedicatedHosts operation to query the host information in the RDS dedicated cluster.

• If you do not have a host, you can call the CreateDedicatedHost operation to add one.

The host ID of the log instance in the dedicated cluster.

This parameter is required when you create an ApsaraDB RDS Enterprise Edition instance in a dedicated cluster. If you do not specify this parameter, the system automatically assigns a host.

• You can call the DescribeDedicatedHosts operation to query the host information in the RDS dedicated cluster.

• If you do not have a host, you can call the CreateDedicatedHost operation to add one.

The parameter template ID. You can call the DescribeParameterGroups operation to query parameter template IDs.

The time zone of the instance. This parameter takes effect only when Engine is set to MySQL or PostgreSQL.

• If Engine is set to MySQL:

  • This parameter specifies the UTC time zone. Valid values: -12:59 to +13:00.

  • Instances with Premium Local SSDs can use named time zones, such as Asia/Hong_Kong. For more information about named time zones, see Named time zone reference.

• If Engine is set to PostgreSQL:

  • This parameter specifies a named time zone. UTC time zones are not supported. For more information about named time zones, see Named time zone reference.

  • This parameter can be configured only for PostgreSQL instances with cloud disks.

Specifies whether table names are case-sensitive. Valid values:

• true: not case-sensitive (default).

• false: case-sensitive.

The minor engine version of the ApsaraDB RDS instance. This parameter is required only when you create a MySQL or PostgreSQL instance. Format:

• MySQL: <instance version>_<numeric version number>. Examples: rds_20200229, xcluster_20200229, or xcluster80_20200229. Description:

  • rds: High-Availability Edition or Basic Edition.

  • xcluster: MySQL 5.7 RDS Enterprise Edition.

  • xcluster80: MySQL 8.0 RDS Enterprise Edition.

  Note

  You can call the DescribeDBMiniEngineVersions operation to query the numeric version number. For information about version differences, see AliSQL minor version release notes.

• PostgreSQL: rds_postgres_<major version>00_<minor kernel version>. Example: rds_postgres_1400_20220830. Description:

  • 1400: PostgreSQL major version 14.

  • 20220830: AliPG minor kernel version. You can call the DescribeDBMiniEngineVersions operation to query the version. For information about version differences, see PostgreSQL minor version release notes.

  Note

  If Babelfish is enabled in BabelfishConfig, the minor version format for the ApsaraDB RDS for PostgreSQL instance is: rds_postgres_<major version>00_<AliPG minor version>_babelfish.

Specifies whether to enable automatic storage expansion. This parameter is supported only for MySQL and PostgreSQL. Valid values:

• Enable: enabled.

• Disable: disabled (default).

The threshold (percentage) that triggers automatic storage expansion. Valid values:

• 10

• 20

• 30

• 40

• 50

The maximum storage capacity for automatic storage expansion. Automatic expansion does not cause the total storage capacity to exceed this value. Unit: GB.

Specifies whether to perform a dry run for this instance creation request. Valid values:

• true: performs a dry run without creating the instance. The system checks items such as the request parameters, request format, business limits, and available resources.

• false: sends the request and creates the instance after the request passes the check (default).

The user backup ID. You can call the ListUserBackupFiles operation to query user backup IDs. If you specify this parameter, the instance is created from the specified user backup.

The following restrictions apply when you specify this parameter:

• PayType must be set to Postpaid.

• Engine must be set to MySQL.

• EngineVersion must be set to 5.7.

• Category must be set to Basic.

The number of ApsaraDB RDS for MySQL instances to create. This parameter applies only to batch creation of ApsaraDB RDS for MySQL instances.

Valid values: 1 to 20. Default value: 1.

The strategy for batch instance creation. This parameter takes effect only when the Amount parameter is greater than 1. Valid values:

• Atomicity (default): atomic. All instances in the same batch are either created successfully or fail together. If one instance fails to be created, all instances fail.

• Partial: non-atomic. The creation of each instance is independent of other instances in the same batch.

Specifies whether to enable the release protection feature. This parameter is supported only for pay-as-you-go instances. Valid values:

• true: enabled.

• false: disabled (default).

The Babelfish for RDS PostgreSQL configuration.

Configuration format: {"babelfishEnabled":"true","migrationMode":"xxxxxxx","masterUsername":"xxxxxxx","masterUserPassword":"xxxxxxxx"}

Parameter description:

• babelfishEnabled: specifies whether to enable Babelfish. Set the value to true to enable Babelfish. If this parameter is not specified, Babelfish is not enabled by default.

• migrationMode: the database mode. Set the value to single-db for single-database mode or multi-db for multi-database mode.

• masterUsername: the initial administrator account name. The name can contain lowercase letters, digits, and underscores (_). It must start with a letter and end with a letter or digit. It can be up to 63 characters in length and cannot start with pg.

• masterUserPassword: the password of the administrator account. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The password must be 8 to 32 characters in length. Special characters include ! @ # $ % ^ & * () _ + - =.

The internal endpoint of the database.

Endpoint format: xxx.mysql.rds.aliyuncs.com, where xxx is the prefix of the instance ID, such as rm-uf6wjk5***.

The port number to initialize when creating the ApsaraDB RDS instance. Valid values:

• MySQL: 1000 to 65534

• PostgreSQL, SQL Server, MariaDB: 1000 to 5999

A deprecated parameter. You do not need to configure this parameter.

Specifies whether to enable the I/O burst feature for Premium ESSDs. Valid values:

• true: enabled.

• false: disabled.

Specifies whether to enable automatic payment. Valid values:

• true: enabled. Make sure that your account balance is sufficient.

• false: generates an order without deducting fees.

Specifies whether to enable the Buffer Pool Extension (BPE) feature for Premium ESSDs. Valid values:

• 1: enabled.

• 0: disabled.

Specifies whether to enable the cold data archiving feature for Premium ESSDs. Valid values:

• true: enabled.

• false: disabled.

The IP address whitelist. To specify multiple IP addresses, separate them with commas (,). No spaces are allowed before or after the commas. Example: 192.168.0.1,172.16.213.9.

Specifies whether to enable automatic creation of a database proxy. Valid values:

• true: enabled. A general-purpose database proxy is created by default.

• false: disabled.

Specifies whether to use coupons. Valid values:

• true: uses coupons.

• false (default): does not use coupons.

The coupon code.

Specifies whether to enable the 16KB atomic write feature. Valid values:

• optimized: enabled.

• none (default): disabled.

Specifies whether to enable or disable RDS MySQL native replication. Valid values:

• ON: enabled.

• OFF: disabled.