ApsaraDB RDS:CreateDBInstance

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

The database engine type. 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, discontinued), 2008r2 (Premium Local SSD, discontinued), 2012 (Enterprise Edition, single-node), 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 more information, see Primary instance types.

To create a Serverless instance, use 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

Instance storage capacity of the instance, in GB. Instance storage capacity increases in increments of 5 GB. For the valid values, see Instance specifications.

Deprecated parameter. You do not need to configure this parameter.

The network connectivity type of the instance. The value is fixed as Intranet, which indicates an internal network connection.

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

The IP whitelist of the instance. Separate multiple entries with commas (,). Duplicate entries are not allowed. You can add up to 1,000 IP addresses or CIDR blocks per instance. The following formats are supported:

• IP address format, for example: 10.10.XX.XX.

• CIDR format, for example: 10.10.XX.XX/24 (Classless Inter-Domain Routing, where 24 indicates the prefix length of the address and the valid range is 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 method. MariaDB instances do not support this billing method. 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 set this parameter to 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 deployment or multi-zone deployment.

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

• For RDS Cluster Edition instances, two-node clusters require ZoneIdSlave1, and three-node clusters require both ZoneIdSlave1 and ZoneIdSlave2.

The zone ID of the secondary node.

• If you set this parameter to Auto, the instance is deployed across multiple zones and a zone is automatically selected for the secondary node.

• If this parameter is set to the same value as ZoneId, the instance is deployed in a single zone.

• If this parameter is set to a different value from ZoneId, the instance is deployed across multiple zones.

ApsaraDB RDS for MySQL Cluster Edition instances support creating one or two secondary nodes when you create an instance. If you have this requirement, use this parameter to specify the zone 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 access mode.

• Safe: database proxy mode.

Default value: assigned by the RDS system.

The VPC ID.

The vSwitch ID.

• Zone mapping: The zone of the vSwitch specified by VSwitchId 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 respectively.

• Network type requirement: The network type specified by InstanceNetworkType must be VPC.

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

• Character restriction: VSwitchId 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 by default.

The subscription duration. Valid values:

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

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

Specifies whether the subscription instance is billed on a yearly or monthly basis. Valid values:

• Year: yearly.

• Month: monthly.

The resource group ID.

The storage type of the instance. Valid values:

• local_ssd: instance with 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; no longer available for purchase in some regions).

The default value of this parameter is automatically determined based on the instance type code specified in the DBInstanceClass parameter:

• If the instance type code corresponds to an instance with Premium Local SSDs, the default value is local_ssd.

• If the instance type code corresponds to a cloud disk instance, the default value is cloud_essd.

The business extension parameter.

The ID of the key used for cloud disk encryption in the same region. Specifying this parameter enables cloud disk encryption (which cannot be disabled after it is enabled) and requires you to also specify RoleARN.

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

The Alibaba Resource Name (ARN) of the RAM role that grants the RDS service account access to KMS. You can call the CheckCloudResourceAuthorized operation to retrieve the ARN.

Specifies whether to enable auto-renewal for the instance. This parameter is valid only when you create a subscription instance. 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 a SQL Server Enterprise Cluster Edition or a Basic Edition Enterprise Edition instance. For example, when you create a Basic Edition 2022 Enterprise Cluster Edition (2022_ent) instance, 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 ID of the dedicated cluster host group.

Required when creating an RDS instance in a dedicated cluster.

• Call the DescribeDedicatedHostGroups operation to query RDS host group information.

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

The host ID for the primary instance in a dedicated cluster.

Required when creating an RDS instance in a dedicated cluster. If you do not specify this parameter, the system automatically assigns a host.

• Call DescribeDedicatedHosts to query host information in an RDS host group.

• If you have no hosts, call CreateDedicatedHost to add one.

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

Required when you create an 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 an RDS dedicated cluster.

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

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

This parameter is required when you create an 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 an RDS dedicated cluster.

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

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

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

• Engine is set to MySQL:

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

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

• Engine is set to PostgreSQL:

  • This parameter configures 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 when the instance uses cloud disks.

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

• true: Table names are case-insensitive (default).

• false: Table names are case-sensitive.

The minor engine version of the RDS instance to create. 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 query the numeric version number by calling the DescribeDBMiniEngineVersions operation. For differences between versions, see AliSQL minor version release notes.

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

  • 1400: PostgreSQL major version 14.

  • 20220830: AliPG minor engine version. You can query this value by calling the DescribeDBMiniEngineVersions operation. For differences between versions, see PostgreSQL minor version release notes.

  Note

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

Specifies whether to enable automatic storage expansion. Only MySQL and PostgreSQL support this parameter. Valid values:

• Enable: Enabled.

• Disable: Disabled (default).

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

• 10

• 20

• 30

• 40

• 50

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

Specifies whether to perform a dry run for this operation. Valid values:

• true: Performs a dry run without creating the instance. The dry run checks request parameters, request format, business limits, and resource availability.

• false: Sends a normal request and creates the instance after the check passes (default).

The user backup ID. You can call the ListUserBackupFiles operation to query the ID. If you specify this parameter, an instance is created based on the user backup.

If you specify this parameter, the following limits apply:

• 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 batch instance creation strategy. 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 created successfully, or none are created if any instance fails.

• Partial: Non-atomic. The creation of each instance is not affected by other instances in the same batch.

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

• true: Enabled.

• false: Disabled (default).

The Babelfish for ApsaraDB RDS for PostgreSQL configuration.

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

Parameter description:

• babelfishEnabled: Specifies whether to enable Babelfish. Set this parameter to true to enable Babelfish. If this parameter is not configured, Babelfish is disabled by default.

• migrationMode: The database model. Set this parameter to single-db for single-database mode or multi-db for multi-database mode.

• masterUsername: The initial administrator account. The username 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.

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

Specifies the port to initialize when creating an RDS instance. Valid values:

• MySQL: 1000 to 65534

• PostgreSQL, SQL Server, and MariaDB: 1000 to 5999

Deprecated parameter. You do not need to configure this parameter.

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

• true: Enabled.

• false: Disabled.

Specifies whether to enable automatic payment. Valid values:

• true: Enables automatic payment. Make sure that your account balance is sufficient.

• false: Generates an order without charging 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 data archiving feature for Premium ESSDs. Valid values:

• true: Enabled.

• false: Disabled.

The whitelist. When you need to configure multiple IP addresses, separate them with commas. Do not add spaces before or after the commas. Example: 192.168.0.1,172.16.213.9.

Specifies whether to automatically create a proxy. Valid values:

• true: Enables automatic creation. The default proxy type is general-purpose database proxy.

• false: Disables automatic creation.

Specifies whether to use a coupon. Valid values:

• true: Use a coupon.

• false (default): Do not use a coupon.

The coupon code.

The switch for the 16KB atomic write feature. Valid values:

• optimized: Enabled.

• none (default): Disabled.

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

• ON: Enabled.

• OFF: Disabled.