ApsaraDB RDS:CreateDBInstance

The region ID. You can call the DescribeRegions operation to query the most recent region list.

The database engine of the instance. Valid values:

• MySQL
• SQLServer
• PostgreSQL
• MariaDB

The database engine version of the instance. Valid values:

• Regular instance

  • Valid values when you set Engine to MySQL: 5.5, 5.6, 5.7, and 8.0
  • Valid values when you set Engine to SQLServer: 08r2_ent_ha (cloud disks, discontinued), 2008r2 (local disks, discontinued), 2012 (SQL Server EE 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, and 2022_web
  • Valid values when you set Engine to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, and 16.0
  • Valid value if you set Engine to MariaDB: 10.3

• Serverless instance

  • Valid values when you set Engine to MySQL: 5.7 and 8.0
  • Valid values when you set Engine to SQLServer: 2016_std_sl, 2017_std_sl, and 2019_std_sl
  • Valid values when you set Engine to PostgreSQL: 14.0, 15.0, and 16.0

The instance type of the instance. You can specify an instance type of the standard or YiTian product type. For more information, see Primary ApsaraDB RDS instance types.

To create a serverless instance, set this parameter to one of the following values:

• If you want to create a serverless instance that runs MySQL on RDS Basic Edition, set this parameter to mysql.n2.serverless.1c.
• If you want to create a serverless instance that runs MySQL on RDS High-availability Edition, set this parameter to mysql.n2.serverless.2c.
• If you want to create a serverless instance that runs SQL Server, set this parameter to mssql.mem2.serverless.s2.
• If you want to create a serverless instance that runs PostgreSQL on RDS Basic Edition, set this parameter to pg.n2.serverless.1c.
• If you want to create a serverless instance that runs PostgreSQL on RDS High-availability Edition, set this parameter to pg.n2.serverless.2c.

The storage capacity of the instance. Unit: GB. The storage capacity increases in increments of 5 GB. For more information, see Primary ApsaraDB RDS instance types.

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

The network connection type of the instance. The value of this parameter is fixed as Intranet, indicating an internal network connection.

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

The IP address whitelist of the instance. For more information, see Use a database client or the CLI to connect to an ApsaraDB RDS for MySQL instance. If the IP address whitelist contains more than one entry, separate the entries with commas (,). Each entry must be unique. The IP address whitelist can contain up to 1,000 entries. The entries in the IP address whitelist must be in one of the following formats:

• IP addresses, such as 10.10.XX.XX.
• CIDR blocks, such as 10.10.XX.XX/24. In this example, 24 indicates that the prefix of each IP address in the IP address whitelist is 24 bits in length. You can replace 24 with a value within the range of 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. This value is not supported for instances that run MariaDB. For more information, see Overview of serverless ApsaraDB RDS for MySQL instances, Overview of serverless ApsaraDB RDS for SQL Server instances, and Overview of serverless ApsaraDB RDS for PostgreSQL instances.

The zone ID of the primary instance.

• If you specify a virtual private cloud (VPC) and a vSwitch, you must specify the ID of the zone to which the specified vSwitch belongs. Otherwise, the instance cannot be created.
• If the instance runs RDS High-availability Edition, you must specify the ZoneIdSlave1 parameter. The ZoneIdSlave1 parameter specifies whether to use the single-zone deployment method or the multi-zone deployment method.
• If the instance runs RDS Enterprise Edition, you must specify the ZoneIdSlave1 and ZoneIdSlave2 parameters. The ZoneIdSlave1 and ZoneIdSlave2 parameters specify whether to use the single-zone deployment method or the multi-zone deployment method.
• If the instance runs MySQL on RDS Cluster Edition, you must specify the ZoneIdSlave1 parameter for the RDS cluster that has two nodes and the ZoneIdSlave1 and ZoneIdSlave2 parameters for the RDS cluster that has three nodes.

The zone ID of the secondary instance.

• If you set this parameter to Auto, the multi-zone deployment method is used and the zone of the secondary instance is automatically configured.
• If you set this parameter to the same value as the ZoneId parameter, the single-zone deployment method is used.
• If you set this parameter to a value that is different from the value of the ZoneId parameter, the multiple-zone deployment method is used.

The zone ID of the other secondary node. When you create an ApsaraDB RDS for MySQL cluster, you can create one to two secondary nodes for the cluster. This parameter applies if you create a cluster that contains two secondary nodes.

The network type of the instance. Valid values:

• VPC: virtual private cloud (VPC)
• Classic: the classic network

The connection mode of the instance. Valid values:

• Standard: standard mode
• Safe: database proxy mode

ApsaraDB RDS automatically assigns a connection mode to the instance.

The ID of the VPC to which the instance belongs.

The vSwitch ID. The vSwitch must belong to the zone that is specified by ZoneId.

• If you set InstanceNetworkType to VPC, you must also specify this parameter.
• If you set the ZoneSlaveId1 parameter to a value that is not Auto, you must specify the IDs of two vSwitches for this parameter and separate the IDs with a comma (,). The ZoneSlaveId1 parameter specifies the zone ID of the secondary node.
• The value cannot contain spaces, exclamation points (!), or special characters such as number signs (#), dollar signs ($), ampersands (&), and percent signs (%).

The private IP address of the instance. The private IP address must be within the CIDR block that is supported by the specified vSwitch. ApsaraDB RDS automatically assigns a private IP address to the instance based on the values of the VPCId and vSwitchId parameters.

The subscription duration of the instance. Valid values:

• If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 5.
• If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 11.

The unit of the subscription duration. Valid values:

• Year
• Month

The ID of the resource group.

The storage type of the instance. Valid values:

• local_ssd: local SSD. This is the recommended storage type.
• general_essd: general Enterprise SSD (ESSD). This is the recommended storage type.
• cloud_essd: PL1 ESSD
• cloud_essd2: PL2 ESSD
• cloud_essd3: PL3 ESSD
• cloud_ssd: standard SSD. This storage type is not recommended. Standard SSDs are no longer available for purchase in some Alibaba Cloud regions.

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

• If the instance type specifies the local SSD storage type, the default value of this parameter is local_ssd.
• If the instance type specifies the standard SSD or ESSD storage type, the default value of this parameter is cloud_essd.

The additional business information about the instance.

The ID of the key that is used for cloud disk encryption in the region in which the instance is deployed. If this parameter is specified, cloud disk encryption is enabled and you must also specify the RoleARN parameter. Cloud disk encryption cannot be disabled after it is enabled.

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

The Alibaba Cloud Resource Name (ARN) that is provided by your Alibaba Cloud account for RAM users. RAM users can use the ARN to connect ApsaraDB RDS to KMS. You can call the CheckCloudResourceAuthorized operation to query the ARN.

Specifies whether to enable auto-renewal for the instance. You must specify this parameter only if the instance uses the subscription billing method. Valid values:

• true
• false

The RDS edition of the instance. Valid values:

• Regular RDS instance

  • Basic: RDS Basic Edition
  • HighAvailability: RDS High-availability Edition
  • cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL or PostgreSQL
  • AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server
  • Finance: RDS Basic Edition for serverless instances

• Serverless instance

  • serverless_basic: RDS Basic Edition for serverless instances. This edition is available only for instances that run MySQL and PostgreSQL.
  • serverless_standard: RDS High-availability Edition for serverless instances. This edition is available only for instances that run MySQL and PostgreSQL.
  • serverless_ha: RDS High-availability Edition for serverless instances. This edition is available only for instances that run SQL Server.

The ID of the dedicated cluster to which the instance belongs.

If you create the instance in a dedicated cluster, you must specify this parameter.

• You can call the DescribeDedicatedHostGroups operation to query the information about the dedicated cluster.
• If no dedicated clusters are created, you can call the CreateDedicatedHostGroup operation to create a dedicated cluster.

The ID of the host to which the instance belongs in the specified dedicated cluster.

If you create the instance in a dedicated cluster, you must specify this parameter. If you do not specify this parameter, the system automatically assigns a host.

• You can call the DescribeDedicatedHosts operation to query the host in the dedicated cluster.
• If no hosts are created, you can call the CreateDedicatedHost operation to create a host.

The ID of the host to which the secondary instance belongs in the specified dedicated cluster.

If you want to create an instance that runs RDS High-availability Edition or RDS Enterprise Edition in a dedicated cluster, you must specify this parameter. If you do not specify this parameter, the system automatically assigns a host.

• You can call the DescribeDedicatedHosts operation to query the host in the dedicated cluster.
• If no hosts are created, you can call the CreateDedicatedHost operation to create a host.

The ID of the host to which the logger instance belongs in the specified dedicated cluster.

If you want to create an instance that runs RDS Enterprise Edition in a dedicated cluster, you must specify this parameter. If you do not specify this parameter, the system automatically assigns a host.

• You can call the DescribeDedicatedHosts operation to query the host in the dedicated cluster.
• If no hosts are created, you can call the CreateDedicatedHost operation to create a host.

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

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

• If you set Engine to MySQL:

  • The time zone of the instance is in UTC. Valid values: -12:59 to +13:00.
  • If the instance uses local SSDs, you can specify the name of the time zone. Example: Asia/Hong_Kong. For more information, see Time zones.

• If you set Engine to PostgreSQL:

  • The time zone of the instance is not in UTC. For more information, see Time zones.
  • You can specify this parameter only when the instance runs PostgreSQL with standard SSDs or ESSDs.

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

• true: Table names are not case-sensitive. This is the default value.
• false: Table names are case-sensitive.

The minor engine version of the instance. This parameter is required only when you create an instance that runs MySQL or PostgreSQL. The value format varies based on the database engine of the instance.

• If you create an instance that runs MySQL, the value is in the following format: <RDS edition>_<Minor engine version>. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229.

  • rds: The instance runs RDS Basic Edition or RDS High-availability Edition.

  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.

  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.

  Note You can call the DescribeDBMiniEngineVersions operation to query the minor engine version. For more information about the differences between minor engine versions of AliSQL, see Release notes.

• If you create an instance that runs PostgreSQL, the value is in the following format: rds_postgres_<Major engine version>00_<Minor engine version>. Example: rds_postgres_1400_20220830.

  • 1400: The major engine version is PostgreSQL 14.

  • 20220830: the AliPG version. You can call the DescribeDBMiniEngineVersions operation to query the AliPG version. For more information about minor engine versions, see Release notes for AliPG.

  Note If you configure the BabelfishConfig parameter for your instance that runs PostgreSQL and set the babelfishEnabled field to true, the value of this parameter is in the following format: rds_postgres_Major engine version00_AliPG version_babelfish.

Specifies whether to enable the automatic storage expansion feature for the instance. If the instance runs MySQL or PostgreSQL, this feature is supported. Valid values:

• Enable
• Disable (default)

The threshold in percentage based on which automatic storage expansion is triggered. Valid values:

• 10
• 20
• 30
• 40
• 50

The maximum storage capacity that is allowed for automatic storage expansion. The storage capacity of the instance cannot exceed the maximum storage capacity. Unit: GB.

Specifies whether to perform a dry run. Valid values:

• true: performs a dry run but does not create the instance. The system checks items such as the request parameters, request format, service limits, and available resources.
• false (default): performs a dry run and sends the request. If the request passes the dry run, the instance is created.

The ID of the full backup file. You can call the ListUserBackupFiles operation to query the ID of the full backup file. If you want to create an instance by using the data of a backup file, you must specify this parameter.

This parameter is supported only when the following requirements are met:

• The PayType parameter is set to Postpaid.
• The Engine parameter is set to MySQL.
• The EngineVersion parameter is set to 5.7.
• The Category parameter is set to Basic.

The number of ApsaraDB RDS for MySQL instances that you want to create. The parameter takes effect only when you create multiple ApsaraDB RDS for MySQL instances at a time by using a single request.

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

The policy based on which multiple instances are created. The parameter takes effect only when the value of the Amount parameter is greater than 1. Valid values:

• Atomicity (default): atomicity. The instances are all created together. If one instance cannot be created, none of the instances are created.
• Partial: non-atomicity. Each instance is independently created. The failure in creating an instance does not affect the creation of the other instances.

The tags that are added to instances.

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

• true
• false (default)

The configuration of the Babelfish feature for the instance that runs PostgreSQL.

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

The following list describes the fields in the format:

• babelfishEnabled: specifies whether to enable Babelfish for the instance. If you set this field to true, you enable Babelfish for the instance. If you leave this parameter empty, Babelfish is disabled for the instance.
• migrationMode: The migration mode of the instance. Valid values: single-db and multi-db.
• masterUsername: The username of the 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. It must be 8 to 32 characters in length. The password can contain any of the following characters: ! @ # $ % ^ & * ( ) _ + - =.

The settings of the serverless instance. This parameter is required when you create a serverless instance.

The internal endpoint that is used to connect to the instance.

The port. You can initialize the port when you create the instance.

• Valid values if the instance runs MySQL: 1000 to 65534
• Valid values if the instance runs PostgreSQL, SQL Server, or MariaDB: 1000 to 5999

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

Specifies whether to enable the I/O burst feature of general ESSDs. Valid values:

• true
• false

Specifies whether to enable the automatic payment feature. Valid values:

• true: enables the feature. Make sure that your account balance is sufficient.
• false: disables the feature. An unpaid order is generated.

Specifies whether to enable the I/O acceleration feature of general ESSDs. Valid values:

• 1: enabled
• 0: disabled

Specifies whether to enable the data archiving feature of general ESSDs. Valid values:

• true
• false

The entries in the whitelist. If you enter multiple IP addresses or CIDR blocks, you must separate the IP addresses or CIDR blocks with commas (,). Do not add spaces preceding or following the commas. Example: 192.168.0.1,172.16.213.9.

Specifies whether to automatically create a database proxy. Valid values:

• true: automatically creates a database proxy. By default, a general-purpose database proxy is created.
• false: does not automatically create a database proxy.