CreateDBInstance-阿里云帮助中心

Use this API to create an RDS instance.

Operation description

Supported engines

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rds:CreateDBInstance

create

*All Resource

*

rds:ResourceTag
rds:Engine
rds:EngineVersion
rds:DBInstanceClass
rds:DBInstanceStorage

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the latest list of regions.	cn-hangzhou
Engine	string	Yes	The database engine. Valid values: MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	Yes	The database engine version. Valid values: General-purpose instances MySQL: 5.5, 5.6, 5.7, and 8.0 SQL Server: 08r2_ent_ha (cloud disk edition, discontinued), 2008r2 (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, and 2022_web PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0, 17.0, and 18.0 MariaDB: 10.3 and 10.6 Serverless instances MySQL: 5.7 and 8.0 SQL Server: 2016_std_sl, 2017_std_sl, and 2019_std_sl PostgreSQL: 14.0, 15.0, 16.0, 17.0, and 18.0 Note You cannot create Serverless instances that run MariaDB. For SQL Server instances, `_ent` indicates Enterprise Cluster Edition, `_ent_ha` indicates Enterprise Edition, `_std_ha` indicates Standard Edition, and `_web` indicates Web Edition. Instances that run SQL Server 2014 are not available for purchase on the international site (alibabacloud.com). Babelfish for RDS PostgreSQL instances support only major version 15.0.	8.0
DBInstanceClass	string	Yes	The instance type. You can specify a standard or Yitian instance type. For more information, 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	mysql.n2.medium.2c
DBInstanceStorage	integer	Yes	The storage capacity of the instance. Unit: GB. The value must be an increment of 5. For more information about the value range, see primary instance types.	100
SystemDBCharset	string	No	This parameter is deprecated and no longer used.	gbk
DBInstanceNetType	string	Yes	The network connection type of the instance. Set the value to Intranet for internal network connections.	Intranet
DBInstanceDescription	string	No	The description of the instance. The description must be 2 to 255 characters long. It must start with a letter or a Chinese character and can contain only letters, Chinese characters, digits, and hyphens (-). Note The description cannot start with `http://` or `https://`.	testInstance
SecurityIPList	string	Yes	The IP whitelist of the instance. Separate multiple entries with a comma. Duplicate entries are not allowed. You can add up to 1,000 IP addresses or CIDR blocks to a single instance. The following formats are supported: IP addresses, such as `10.10.XX.XX`. CIDR notation, such as 10.10.XX.XX/24. The number 24 indicates the prefix length of the address. The prefix length ranges from 1 to 32.	10.10.XX.XX/24
ClientToken	string	No	A 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 must be an ASCII string up to 64 characters in length.	ETnLKlblzczshOTUbOCz****
PayType	string	Yes	The billing method of the instance. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription. Serverless: The Serverless billing method. This billing method is not supported for MariaDB instances. 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. Note Manual confirmation is not required.	Postpaid
ZoneId	string	No	The ID of the primary availability zone. If you specify a VPC and a vSwitch, this parameter must match the availability zone of the vSwitch. For High-Availability Edition instances, you must also specify the ZoneIdSlave1 parameter to configure a single-AZ or multi-AZ deployment. For Enterprise Edition (Three Nodes) instances, you must also specify the ZoneIdSlave1 and ZoneIdSlave2 parameters to configure a single-AZ or multi-AZ deployment. For RDS Cluster Edition instances with two nodes, you must also specify ZoneIdSlave1. For those with three nodes, you must also specify ZoneIdSlave1 and ZoneIdSlave2.	cn-hangzhou-b
ZoneIdSlave1	string	No	The ID of the secondary availability zone. If you set this parameter to Auto, the system automatically selects an availability zone for the secondary node, and this configures a multi-AZ deployment. If you set this parameter to the same value as the ZoneId parameter, this configures a single-AZ deployment. If you set this parameter to a different value from the ZoneId parameter, this configures a multi-AZ deployment.	cn-hangzhou-c
ZoneIdSlave2	string	No	When you create an RDS Cluster Edition instance that runs RDS for MySQL, you can create one or two secondary nodes. If you require a second secondary node, use this parameter to specify its availability zone.	cn-hangzhou-d
InstanceNetworkType	string	No	The network type of the instance. Valid values: VPC: virtual private cloud. Classic: classic network. Note ApsaraDB RDS for MySQL instances that use cloud disks support only VPCs. You must set this parameter to VPC. ApsaraDB RDS for PostgreSQL and ApsaraDB RDS for MariaDB instances support only VPCs. You must set this parameter to VPC. ApsaraDB RDS for SQL Server single-node instances and Web Edition instances support both the classic network and VPCs. Other SQL Server instances support only VPCs. You must set this parameter to VPC for these other instances.	VPC
ConnectionMode	string	No	The connection mode of the instance. Valid values: Standard: standard connection mode Safe: database proxy mode By default, the system automatically assigns a connection mode. Note Instances that run SQL Server 2012, 2016, or 2017 support only the standard connection mode.	Standard
VPCId	string	No	The VPC ID. Note This parameter is valid only when you set the InstanceNetworkType parameter to VPC.	vpc-****
VSwitchId	string	No	The vSwitch ID. Availability zone mapping: The availability zone of the vSwitch must correspond to the primary availability zone (ZoneId) and the secondary availability zone (ZoneIdSlave1). If you specify two vSwitch IDs, their sequence must align with the sequence of ZoneId and ZoneSlaveId1. Network type constraint: The InstanceNetworkType parameter must be set to VPC. Multiple vSwitch requirement: If you specify ZoneSlaveId1 (the ID of the secondary availability zone) and its value is not Auto, you must specify two vSwitch IDs, separated by a comma (,). Character constraint: The vSwitch ID cannot contain special characters such as , `!`, `#`, `￥`, `&`, or `%`.	vsw-****
PrivateIpAddress	string	No	The internal IP address of the instance. The IP address must be within the CIDR block of the specified vSwitch. By default, the system automatically assigns an IP address from the specified vSwitch.	172.16.XX.XX
UsedTime	string	No	The subscription duration. Valid values: If you set the Period parameter to Year, the value of the UsedTime parameter can be 1, 2, 3, 4, or 5. If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 11. Note This parameter is required if you set the PayType parameter to Prepaid.	2
Period	string	No	The unit of the subscription duration for a prepaid instance. Valid values: Year: year Month: month Note This parameter is required if you set the PayType parameter to Prepaid.	Year
ResourceGroupId	string	No	The resource group ID.	rg-acfmy****
DBInstanceStorageType	string	No	The storage type of the instance. Valid values: local_ssd: local SSDs (recommended) general_essd: General Purpose Enhanced SSD (ESSD) (recommended) cloud_essd: performance level 1 (PL1) ESSD cloud_essd2: PL2 ESSD cloud_essd3: PL3 ESSD cloud_ssd: standard SSD (not recommended, and discontinued in some regions) The default value of this parameter is determined by the instance type code specified by the DBInstanceClass parameter: If the instance type code specifies local SSDs, the default value is local_ssd. If the instance type code specifies cloud disks, the default value is cloud_essd. Note Serverless instances support only PL1 ESSDs and General Purpose ESSDs.	general_essd
BusinessInfo	string	No	The business information.	121436975448952
EncryptionKey	string	No	The ID of the customer master key (CMK) that is used for disk encryption. Specifying this parameter enables disk encryption, which cannot be disabled later. You must also specify the RoleARN parameter. The CMK must be in the same region as the instance. You can view the key ID in the Key Management Service (KMS) console or create a new key. For more information, see Create a key. Note For ApsaraDB RDS for MySQL, PostgreSQL, and SQL Server instances, you can omit this parameter and specify only the RoleARN parameter to use the service key to create an instance with disk encryption enabled. You can configure a RAM authorization policy to require that a RAM user must enable disk encryption when creating an instance. If disk encryption is not enabled in the request, the instance creation fails. The RAM policy is as follows: `{"Version":"1","Statement":[{"Effect":"Deny","Action":"rds:CreateDBInstance","Resource":"","Condition":{"StringEquals":{"rds:DiskEncryptionRequired":"false"}}}]}` Warning* This configuration also affects the CreateOrder API operation that is called when you create an instance in the console.	0d24*****-da7b-4786-b981-9a164dxxxxxx
RoleARN	string	No	The ARN of the RAM role that ApsaraDB RDS uses to access KMS. You can call the CheckCloudResourceAuthorized operation to query the ARN. Important This parameter is required if you enable disk encryption.	acs:ram::1406****:role/aliyunrdsinstanceencryptiondefaultrole
AutoRenew	string	No	Specifies whether to enable auto-renewal for the instance. This parameter is valid only when you create a subscription instance. Valid values: true false Note If you select a monthly subscription, the auto-renewal period is one month. If you select an annual subscription, the auto-renewal period is one year.	true
Category	string	No	The instance edition. Valid values: General-purpose instances Basic: Basic Edition HighAvailability: High-Availability Edition cluster: RDS Cluster Edition for MySQL or PostgreSQL AlwaysOn: SQL Server Always On Cluster Edition Finance: Enterprise Edition (Three Nodes) Note This parameter is required when you create an SQL Server Enterprise Cluster Edition instance, a Basic Standard Edition instance, or a Basic Enterprise Edition instance. For example, if you create a Basic Edition instance that runs SQL Server 2022 Enterprise Cluster Edition (2022_ent), you must set this parameter to Basic. Serverless instances serverless_basic: Serverless Basic Edition (available only for MySQL and PostgreSQL). serverless_standard: Serverless High-Availability Edition (available only for MySQL and PostgreSQL). serverless_ha: Serverless High-Availability Edition for SQL Server. Note This parameter is required if you set the PayType parameter to Serverless.	HighAvailability
DedicatedHostGroupId	string	No	The dedicated cluster ID. This parameter is required to create an instance in a dedicated cluster. You can call the DescribeDedicatedHostGroups operation to query information about RDS dedicated host groups. If you have not created an RDS dedicated host group, you can call the CreateDedicatedHostGroup operation to create one.	dhg-4n****
TargetDedicatedHostIdForMaster	string	No	The host ID of the primary instance in the dedicated cluster. This parameter is required when you create an RDS instance in a dedicated cluster. If you omit this parameter, the system automatically allocates a host. You can call the DescribeDedicatedHosts operation to query information about the hosts in an RDS dedicated host group. If you do not have a host, you can call the CreateDedicatedHost operation to add one.	i-bp****
TargetDedicatedHostIdForSlave	string	No	The host ID of the secondary instance in the dedicated cluster. Required for High-Availability Edition or Enterprise Edition (Three Nodes) instances in a dedicated cluster. If omitted, the system automatically allocates a host. You can call the DescribeDedicatedHosts operation to query information about the hosts in an RDS dedicated cluster. If you do not have a host, you can call the CreateDedicatedHost operation to add one.	i-bp****
TargetDedicatedHostIdForLog	string	No	The host ID of the logger instance in the dedicated cluster. Required for Enterprise Edition (Three Nodes) instances in a dedicated cluster. If omitted, the system automatically allocates a host. You can call the DescribeDedicatedHosts operation to query information about the hosts in an RDS dedicated cluster. If you do not have a host, you can call the CreateDedicatedHost operation to add one.	i-bp****
DBParamGroupId	string	No	The ID of the parameter group. You can call the DescribeParameterGroups operation to query the ID. Note This parameter is supported only for MySQL and PostgreSQL instances. If you do not specify this parameter, the default system parameter group is used. You can also specify a custom parameter group.	rpg-sys-****
DBTimeZone	string	No	The time zone of the instance. This parameter is valid only when you set the Engine parameter to MySQL or PostgreSQL. If you set Engine to MySQL: This parameter specifies a UTC time zone. The value must be in the range of -12:59 to +13:00. You can use a named time zone for instances that use local SSDs, such as Asia/Hong_Kong. For more information, see Time zone naming conventions. If you set Engine to PostgreSQL: This parameter specifies a named time zone. UTC time zones are not supported. For more information, see Time zone naming conventions. This parameter is valid only for PostgreSQL instances that use cloud disks. Note You can set the time zone when you create a primary instance. You cannot set the time zone for read-only instances. A read-only instance inherits the time zone of its primary instance. If you do not specify this parameter, the system selects a default time zone based on the region of the instance.	+08:00
DBIsIgnoreCase	string	No	Specifies whether table names are case-sensitive. Valid values: true: case-insensitive (default) false: case-sensitive	true
TargetMinorVersion	string	No	The minor engine version of the instance. This parameter applies only to MySQL and PostgreSQL instances. Format: MySQL: `<Instance version>_<Digital version number>`. Example: `rds_20200229`, `xcluster_20200229`, or `xcluster80_20200229`. The prefixes are described as follows: rds: High-Availability Edition or Basic Edition. xcluster: Enterprise Edition (Three Nodes) that runs MySQL 5.7. xcluster80: Enterprise Edition (Three Nodes) that runs MySQL 8.0. Note You can call the DescribeDBMiniEngineVersions operation to query the digital version number. For more information about the version differences, see AliSQL minor version release notes. PostgreSQL: `rds_postgres_<Major version>00_<Minor version number>`. Example: `rds_postgres_1400_20220830`. The parts of the value are described as follows: 1400: The major version is PostgreSQL 14. 20220830: The minor version of the AliPG kernel. You can call the DescribeDBMiniEngineVersions operation to query this version. For more information about the version differences, see PostgreSQL minor version release notes. Note If Babelfish is enabled in the BabelfishConfig parameter, the minor version of the ApsaraDB RDS for PostgreSQL instance is in the following format: `rds_postgres_<Major version>00_<AliPG kernel minor version>_babelfish`.	rds_20200229
StorageAutoScale	string	No	Specifies whether to enable automatic storage expansion. This feature is available only for MySQL and PostgreSQL instances. Valid values: Enable Disable (default) Note After you create the instance, you can call the ModifyDasInstanceConfig operation to adjust this setting. For more information, see Configure automatic storage expansion.	Disable
StorageThreshold	integer	No	The threshold in percentage that triggers automatic storage expansion. Valid values: 10 20 30 40 50 Note This parameter is required if you set the StorageAutoScale parameter to Enable.	50
StorageUpperBound	integer	No	The upper limit for automatic storage expansion. The total storage capacity of the instance cannot exceed this value. Unit: GB. Note The value must be greater than or equal to 0. This parameter is required if you set the StorageAutoScale parameter to Enable.	2000
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run to check for issues such as invalid parameters, business limits, and available inventory, without creating the instance. false (default): sends a regular request and creates the instance after the request passes the check.	false
UserBackupId	string	No	The ID of the user backup. You can call the ListUserBackupFiles operation to query this ID. If you specify this parameter, you can create an instance from a user backup. The following limits apply if you specify this parameter: The PayType parameter must be set to Postpaid. The Engine parameter must be set to MySQL. The EngineVersion parameter must be set to 5.7. The Category parameter must be set to Basic.	67798****
Amount	integer	No	The number of MySQL instances to create. Use this parameter to create multiple instances in a single request. Valid values: 1 to 20. Default value: 1. Note When you create multiple ApsaraDB RDS for MySQL instances, you can use the Tag.Key and Tag.Value parameters to add tags to the instances in the same batch. This helps you manage these instances by tag after they are created. After multiple ApsaraDB RDS for MySQL instances are created, the API returns only the TaskId, RequestId, and Message parameters, not other detailed parameters. To query the details of individual instances, call the DescribeDBInstanceAttribute operation. If the Engine parameter is not set to MySQL and the value of this parameter is greater than 1, the API call fails and returns the error code `InvalidParam.Engine`.	2
CreateStrategy	string	No	The batch creation policy. This parameter is effective only when the Amount parameter is greater than 1. Valid values: Atomicity (default): If any instance fails to be created, the entire batch creation is rolled back. Partial: The creation of an instance is not affected by other instances in the same batch.	Atomicity
Tag	array<object>	No	The list of tags.
	object	No	The details of the tag list.
Key	string	No	The tag key. If the specified tag key already exists, the tag key is directly bound to the instance. You can call the ListTagResources operation to query existing tags. If the specified tag key does not exist, the tag key is created and then bound to the instance. You cannot specify an empty string. This parameter must be used together with the Tag.Value parameter.	testkey1
Value	string	No	The tag value. If the specified tag value exists for the corresponding tag key, the tag value is directly bound to the instance. You can call the ListTagResources operation to query existing tags. If the specified tag value does not exist for the corresponding tag key, the tag value is created and then bound to the instance. This parameter must be used together with the Tag.Key parameter.	testvalue1
DeletionProtection	boolean	No	Specifies whether to enable deletion protection for the instance. This parameter is valid only for pay-as-you-go instances. Valid values: true: enables deletion protection. false (default): disables deletion protection.	true
BabelfishConfig	string	No	The configurations of Babelfish for ApsaraDB RDS for PostgreSQL. Format: `{"babelfishEnabled":"true","migrationMode":"xxxxxxx","masterUsername":"xxxxxxx","masterUserPassword":"xxxxxxxx"}` The parameters are described as follows: babelfishEnabled: specifies whether to enable Babelfish. Set the value to true to enable Babelfish. If you do not specify this parameter, Babelfish is disabled by default. migrationMode: the database migration mode. Set the value to single-db for single-database mode or multi-db for multi-database mode. masterUsername: the initial administrator account. The name must start with a letter, can contain lowercase letters, digits, and underscores (_), must end with a letter or a digit, and cannot start with pg. The name can be up to 63 characters in length. masterUserPassword: the password of the administrator account. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The special characters are `! @ # $ % ^ & * ( ) _ + - =`. Note This parameter is applicable only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see What is Babelfish?	{"babelfishEnabled":"true","migrationMode":"single-db","masterUsername":"babelfish_user","masterUserPassword":"Babelfish123!"}
ServerlessConfig	object	No	The settings of the Serverless instance. This parameter is required when you create a Serverless instance. Note You cannot create Serverless instances that run MariaDB.
MaxCapacity	number	No	The maximum number of RDS Capacity Units (RCUs) for auto-scaling. Valid values: MySQL: 1 to 32 SQL Server: 2 to 16 PostgreSQL: 1 to 14 Note The value of this parameter must be greater than or equal to the value of MinCapacity and must be an integer.	8
MinCapacity	number	No	The minimum number of RCUs for auto-scaling. Valid values: MySQL: 0.5 to 32 SQL Server: 2 to 16 (only integers are supported) PostgreSQL: 0.5 to 14 Note The value of this parameter must be less than or equal to the value of MaxCapacity.	0.5
AutoPause	boolean	No	Specifies whether to enable the auto-pause feature for the Serverless instance. Valid values: true: enables the feature. false (default): disables the feature. Note This parameter applies only to MySQL and PostgreSQL Serverless instances. If no connections are established to the instance within 10 minutes, the instance is suspended. When a connection is established, the instance is automatically resumed.	true
SwitchForce	boolean	No	Specifies whether to enable forced scaling for the Serverless instance. Valid values: true: enables the feature. false (default): disables the feature. Note This parameter applies only to MySQL and PostgreSQL Serverless instances. If you enable this feature, a service interruption of 30 to 120 seconds occurs during forced scaling. Exercise caution. The elastic scaling of RCUs for an instance usually takes effect immediately. In some special cases, such as when a large transaction is being executed, the scaling cannot be completed immediately. In these cases, you can enable this parameter to perform forced scaling.	false
ConnectionString	string	No	The internal endpoint of the instance. The endpoint is in the format of <prefix>.mysql.rds.aliyuncs.com. The <prefix> is the prefix of the instance ID. Example: `rm-uf6wjk5***`.	rm-uf6wjk5****.mysql.rds.aliyuncs.com
Port	string	No	The port number to be used when you create an RDS instance. Valid values: MySQL: 1000 to 65534 PostgreSQL, SQL Server, and MariaDB: 1000 to 5999	3306
BurstingEnabled	boolean	No	This parameter is deprecated and no longer used.	false
AutoPay	boolean	No	Specifies whether to enable the I/O performance bursting feature for the Enhanced SSD (ESSD). Valid values: true: Enabled. false: Disabled. Note For more information about the I/O performance bursting feature of ESSDs, see What is an Enhanced SSD?.	true
IoAccelerationEnabled	string	No	Specifies whether to enable automatic payment. Valid values: true: Enables automatic payment. Ensure that your account balance is sufficient. false: Generates an order without completing the payment. Note The default value is true. If your account balance is insufficient, set the AutoPay parameter to false. An unpaid order is generated. To pay for the order, log on to the RDS console.	0
ColdDataEnabled	boolean	No	Specifies whether to enable the Buffer Pool Extension (BPE) feature for the Enhanced SSD (ESSD). Valid values: 1: Enabled 0: Disabled	false
WhitelistTemplateList	string	No	Specifies whether to enable the data archiving feature for an Enhanced SSD (ESSD). Possible values: true: Enabled. false: Disabled.	192.168.0.1,172.16.213.9
AutoCreateProxy	boolean	No	The whitelist. To add multiple IP addresses or IP address ranges, separate them with a comma. Do not add spaces before or after the comma. For example, `192.168.0.1,172.16.213.9`.	false
AutoUseCoupon	boolean	No	Specifies whether to automatically create a proxy. Valid values: true: Automatically creates a general-purpose proxy. false: Does not automatically create a proxy.	true
PromotionCode	string	No	Specifies whether to use a coupon. Valid values: true: Use a coupon. false (default): Do not use a coupon. Note If you downgrade the configuration after using a coupon, the amount covered by the coupon will not be refunded.	aliwood-1688-mobile-promotion
OptimizedWrites	string	No	The coupon code.	optimized
ExternalReplication	boolean	No	The switch for the 16K atomic write feature. Valid values: optimized: Enabled. none (default): Disabled.	ON
CustomExtraInfo	string	No	Enable or disable RDS MySQL native replication. Valid values: ON: Enable. OFF: Disable.

Response elements

Element	Type	Description	Example
	object	The response parameters.
DryRunResult	boolean	Indicates whether the dry run for creating the instance was successful. Valid values: true: The dry run was successful. false: The dry run failed. Note This parameter is returned only if you perform a dry run. If the dry run fails, an error is returned.	true
TagResult	boolean	Indicates whether tags were successfully added to the instance. Valid values: true: The tags were successfully added. false: The tags were not added. Note This parameter is returned only if you add tags to the instance.	true
RequestId	string	The request ID.	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC
ConnectionString	string	The internal connection string of the instance.	rm-uf6wjk5****.mysql.rds.aliyuncs.com
Message	string	A message about the batch creation task. Note This parameter is returned only if the value of the Amount parameter is greater than 1.	Batch Create DBInstance Task Is In Process.
DBInstanceId	string	The instance ID. If you set the Amount parameter to a value greater than 1, this parameter returns the IDs of the generated instances, separated by commas (,). For example, setting the Amount parameter to 3 returns three instance IDs. Example: `rm-uf6wjk5***1,rm-uf6wjk5*2,rm-uf6wjk5***3`	rm-uf6wjk5****
Port	string	The port for the internal connection string.	3306
TaskId	string	The ID of the batch creation task. This parameter is returned only if the value of the Amount parameter is greater than 1. You cannot use this task ID to query task details.	s2365879-a9d0-55af-fgae-f2****
DryRun	boolean	Indicates that the request was a dry run to check if the instance can be created. The value is always true. This parameter is returned only if you perform a dry run.	true
OrderId	string	The order ID.	1007893702****

Note

When calling this operation with the latest SDK, a mismatch between the SDK's default client-side timeout and the server-side timeout can cause a request timeout error, even though the operation succeeds. To prevent this, set the ReadTimeout parameter to 20000 before calling the operation. 设置调用超时时间

Examples

Success response

JSON format

{
  "DryRunResult": true,
  "TagResult": true,
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
  "ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
  "Message": "Batch Create DBInstance Task Is In Process.",
  "DBInstanceId": "rm-uf6wjk5****",
  "Port": "3306",
  "TaskId": "s2365879-a9d0-55af-fgae-f2****",
  "DryRun": true,
  "OrderId": "1007893702****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.ParamGroupDBVersion	%s.%s
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	RR309	We have detected a security risk with your payment method. Please proceed with verification via the link in your email or console message and re-submit your order after verification.	A security risk was detected in the default payment method. Please verify your payment method before placing your order. A verification link will be sent to you via email and internal message.
400	InvalidZoneId.NotSupported	The Specified vpc Zone not supported.	VPC-hosted RDS instances cannot be created in the zone. Specify a different zone.
400	InvalidZone.NotSupportedForStorageType	The specified zone is closed or invalid for Specified DBInstanceStorageType.
400	InvalidNetworkTypeClassicWhenCloudStorage	The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.	When selecting a cloud storage type, specifying a InstanceNetworkType value of Classic is not valid.
400	InvalidZone.NotSupported	The Specified Zone not supported.	The zone is invalid.
400	InvalidEssdStorageSize	invalid cloud essd storage size.	The storage size of cloud disks is invalid. Check the storage size.
400	InvalidParameter	Some Reuquest Parameters Is Invalid. Check or Try It Again Later.
400	Pay.AmountLimitExceeded	Pay amount limit exceeded.
400	IncompleteAccountInfo	Your information is incomplete. Complete your information before the operation.	The operation failed. Items that are marked with an asterisk (*) in the account information must be specified. Make sure that you specify these items on the Basic Information page in Account Center.
400	IncompleteTaxInfo	Your tax information is incomplete. Complete your information before the operation.	The operation failed. Your tax information is incomplete. Complete your tax information.
400	InvalidPaymentMethod.Incomplete	No payment method is specified for your account. We recommend that you add a payment method.	No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.
400	InvalidPaymentMethod.Missing	No payment method is specified for your account. We recommend that you add a payment method.	No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.
400	InsuffcientBalanceOrBankAccount	Add a payment method or add funds to the prepayment balance. Get started by creating an instance.	No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.
400	InvalidPaymentMethod.NoAccess	No payment method is specified for your account. We recommend that you add a payment method.
400	InvalidPaymentMethod.InsufficientBalance	No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.
400	Pay.LowFunds	The balance of the advance payment is insufficient or there is no balance of the advance payment.
400	Pay.ChargeChannelNotFound	Failure to obtain the first external payment channel if the advance balance is insufficient.
400	VswitchIpExhausted	Vswitch IP exhausted.	The operation failed. No vSwitch IP addresses are available.
400	InvalidPrivateIpAddress.AlreadyUsed	The specified IP is already used.	The IP address has been used.
400	InvalidEcsImage.NotFound	Sepcified ecs image does not exist
400	InvalidMinorVersion.NotFound	Sepcified minor version does not exists.
400	InvalidConcurrentOperate	Concurrent operation is detected.	Concurrent operations exist. Wait until the previous operation is complete and try again.
400	ZoneId.NotMatchWithCategory	The number of ZoneId specified does not match with category.	The number of zones is not supported for the database engine or the RDS edition of the RDS instance. Modify the zone settings.
400	InvalidSecurityIPList.Format	The specified parameter securityIPList is not valid.	The format of the IP address whitelist does not meet the requirements. Check the IP address whitelist.
400	InvalidDBParamGroupId.Format	The specified parameter dbParamGroupId is not valid.
400	InvalidTargetMinorVersion.Format	The specified parameter targetMinorVersion is not valid.
400	InvalidDedicatedHostGroupId.Format	The specified parameter dedicatedHostGroupId is not valid.
400	InvalidDBInstanceClass.Malformed	The specified parameter DBInstanceClass is not valid.
400	InvalidEngineVersion.Malformed	The specified parameter EngineVersion is not valid.	The database engine version is invalid. Check the database engine version and try again.
400	CreditPayInsufficientBalance	Insufficient credit pay limit. Please contact your channel partner to increase the limit.	The quota runs out. Contact your customer service representatives to increase the quota.
400	InvalidTagKey.Malformed	The Tag.N.Key parameter is empty.	The Tag.N.Key parameter is left unspecified.
400	InvalidTagValue.Malformed	The Tag.N.Value parameter is empty.	The Tag.N.Value parameter is left unspecified.
400	Duplicate.TagKey	The Tag.N.Key contains duplicate keys.	The values of two Tag.N.Key parameters are duplicate.
400	NumberExceed.Tags	The maximum number of Tags is exceeded. The maximum is 20.	The number of tags exceeds 20.
400	MissingParameter.ResourceIds	The parameter ResourceIds.N must not be null.	The ResourceIds.N parameter cannot be empty.
400	InvalidParameter.TagKey	The Tag.N.Key parameter is invalid.	The value of the Tag.N.Key parameter is invalid.
400	InvalidParameter.TagValue	The Tag.N.Value parameter is invalid.	The Tag.N.Value parameter is invalid.
400	NoPermission.SystemTag	You have no permission to use system tags.	You have no permission to use the system tag.
400	InvalidParam.Amount	Amount is allowed from 1 to 20.	Amount is allowed from 1 to 20.
400	InvalidParam.CreateStrategy	Only Atomicity and Partial are allowed.	Only the Atomicity and Partial parameters are supported.
400	InvalidParam.Engine	Only MySQL is allowed when Amount > 1.
400	InvalidMultiZoneInfoList	The Specified Zone Info List is Invaild.
400	InvalidKmsConfigStatus	The Kms Service Config is Invalid.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the Aliyun RDS.
400	InvalidPort.Malformed	Specified port is not valid.	The port number is invalid.
400	InvalidUsedTime	UsedTime can not Less than or equal to zero.	The value of the UsedTime parameter must be greater than 0.
400	Kms.Unauthorized	KMS has not been authorized.	KMS is not authorized.
400	InvalidDBInstanceClass.Offline	The specified instance type is no longer provided. Please specify another instance type.	The instance type that you select is no longer available. Select another instance type.
400	SystemParamGroupCode.Format	Specific DBParamGroupId is not valid.
400	InvalidDBInstanceName.Duplicate	Specified DB instance name already exists in the Aliyun RDS.	The operation failed. The instance name already exists. Specify a different name and try again.
400	ServiceLinkedRole.NotExist	Service linked role for RDS PostgreSQL not exist.	Create the AliyunServiceRoleForRdsPgsqlOnEcs role for ApsaraDB RDS for PostgreSQL.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Hello customer, this area has been abolished.
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Hello customer, this area has been abolished.
400	InvalidPrivateIpAddress.Format	The specified private IP address format is incorrect.	The specified IP address is not in the correct format.
400	InvalidPrivateIpAddress.Mismatch	Specified private IP address is not in the CIDR block of virtual switch.	The VPC endpoint is invalid.
400	TooManyWhitelistTemplateIds	create dbinstance can support attach to up to 10 whitelist templates.	Excessive number of incoming whitelist templates! You can associate up to 10 whitelist templates.
400	UnsupportExtendDisk.NotSupport	Specified DB instance is unsupport extend disk.	Disk expansion is not supported on the specified instance.
400	InvalidWhitelistTemplateId	the template id list is invalid.	The ID of the specified whitelist template is incorrect. Check the setting.
400	InvalidRequestId	The request is copy, check your token.	The request is copy, check your token.
400	InvalidParameter.MinCapacity	The specified parameter 'MinCapacity' is not valid.	The specified parameter 'MinCapacity' is not valid.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidParameter.NotSupportDBInstanceStorageType	Parameter DBInstanceStorageType is invalid.	Invalid DBInstanceStorageType parameter
400	InvalidParam.InstanceNetworkType	Creation of classic network instances is not supported.	Classic network offline, does not support the creation of classic network instances!
400	InvalidOrder.NotFound	Specified order does not exist in RDS.	The specified order does not exist in RDS.
400	InvalidVSwitchId.Format	The specified vswitch Id format is incorrect.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	IncorrectTargetCategory	Current target category does not support this operation.	Current target category does not support this operation.
400	PurchaseDurationInsufficient	The purchase duration does not meet the requirements, please choose again.	The purchase duration does not meet the requirements, please select again.
400	NotFound.ParamGroupId	Current ParamGroupId not found.	The parameter template does not exist.
400	InvalidParamForXfs	Xfs instance must be single tenant standard instance.	Xfs instance must be single tenant standard instance.
400	UnsupportedColdData	Current coldDataEnabled parameter can not support.	The specified region does not support cold storage.
400	AtLeastThreeVSwitchAvailableIp	The primary vswitch requires at least three available IP addresses.	The master switch requires at least 3 available IPs.
400	AtLeastTwoVSwitchAvailableIp	The primary vswitch requires at least two available IP addresses.	The master switch requires at least 2 available IPs.
400	DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance	Current instance is already attached to another duckdb instance, operation is conflict.	The current instance is already associated with another DUCKDB instance, which conflicts with the current DUCKDB operation.
401	CannotDecreaseEssdPerfLevel	cannot decrease cloud essd performance level.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.
403	ByokRoleArnNotFound	The roleArn can not be null.	The roleArn can not be null.
403	RISK.RISK_CONTROL_REJECTION	Risk control rejection.
403	AliCroup2CloudUserCannotBuyNotInnerCommodity	There is no group cloud commodity label, and users within the group are not allowed to purchase.
403	GroupReplicationNotSupport.InvalidEngineVersion	Group Replication requires the instance engine version to be 8.0.
403	GroupReplicationNotSupport.InvalidNodeClassCode	Group Replication requires the ClassCode of each node to be consistent.
403	GroupReplicationNotSupport.InvalidNodeNum	Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.
403	GroupReplicationNotSupport.InvalidXengine	Group Replication is not supported because the instance has xengine tables.
403	GroupReplicationNotSupport.MemoryTooSmall	Group Replication is not supported because the memory is too small.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	CloudDiskEncryptionNotSupport	The encryption key is not allowed for general-purpose instance.	Universal instances do not support cloud disk encryption.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	BasicCategoryNotSupport	The Basic category is not supported.	Basic series not supported
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
403	IncorrectCharacterType	Current DB instance character type does not support this operation.	This operation is not supported for the character type of the instance.
404	InsufficientResourceCapacity	The target availability zone does not have sufficient resources.	The target Availability Zone does not have enough resources.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.