CreateDBInstance - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the CreateDBInstance operation to create an instance.

Operation Description

Before you call this operation, make sure that you understand the billing methods and pricing of ApsaraDB RDS. For more information, see Billable items, billing methods, and pricing.

For more information about ApsaraDB RDS instance types, see Primary ApsaraDB RDS instance types.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Association operation
rds:CreateDBInstance	WRITE	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/*	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Engine	string	Yes	The database engine of the instance. Valid values: MySQL SQLServer PostgreSQL MariaDB NoteTo create a serverless instance, you must set this parameter to MySQL.	MySQL
EngineVersion	string	Yes	The database engine version of the instance. Valid values when you set the Engine parameter to MySQL: 5.5, 5.6, 5.7, and 8.0 Valid values when you set the Engine parameter to SQLServer: 2008r2, 08r2_ent_ha, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_std_ha, 2017_ent, 2019_std_ha, and 2019_ent Valid values when you set the Engine parameter to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, and 15.0 Valid value when you set the Engine parameter to MariaDB: 10.3 NoteTo create a serverless instance, you must set this parameter to 8.0.	5.6
DBInstanceClass	string	Yes	The instance type of the instance. For more information, see Primary ApsaraDB RDS instance types. You can also call the DescribeAvailableResource operation to query the available instance types in a region. NoteTo create a serverless instance, you must set this parameter to mysql.n2.serverless.1c.	rds.mysql.s1.small
DBInstanceStorage	integer	Yes	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. You can also call the DescribeAvailableResource operation to query the storage capacity range that is supported for a specified instance type in a region.	100
SystemDBCharset	string	No	The character set that is used by the instance. This parameter is no longer used.	gbk
DBInstanceNetType	string	Yes	The type of network connection to the instance. Valid values: Internet Intranet	Internet
DBInstanceDescription	string	No	The name of the instance. 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. NoteThe value cannot start with http:// or https://.	Test database
SecurityIPList	string	Yes	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.	10.10.XX.XX/24
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCz*****
PayType	string	Yes	The billing method of the instance. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription. Serverless: serverless. This value is supported only for instances that run MySQL. For more information, see Overview. NoteApsaraDB RDS automatically generates a purchase order and completes the payment.	Postpaid
ZoneId	string	No	The zone ID of the primary instance. If you specify a 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, which 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, which specify whether to use the single-zone deployment method or the multi-zone deployment method.	cn-hangzhou-b
ZoneIdSlave1	string	No	The ID of the zone in which the secondary instance resides. If you set the ZoneIdSlave1 parameter and the ZoneId parameter to the same value, the single-zone deployment method is used. If you set the ZoneIdSlave1 parameter and the ZoneId parameter to different values, the multi-zone deployment method is used.	cn-hangzhou-c
ZoneIdSlave2	string	No	The ID of the zone in which the logger instance resides. If you set the ZoneIdSlave2 parameter and the ZoneId parameter to the same value, the single-zone deployment method is used. If you set the ZoneIdSlave2 parameter and the ZoneId parameter to different values, the multi-zone deployment method is used.	cn-hangzhou-d
InstanceNetworkType	string	No	The network type of the instance. Valid values: VPC: specifies a virtual private cloud (VPC). Classic: specifies the.classic network. This is the default value. Note If the instance runs MySQL and uses standard SSDs or enhanced SSDs (ESSDs), you must set this parameter to VPC. Note If the instance runs PostgreSQL and MariaDB. you must set this parameter to VPC. If the instance runs SQL Server Basic or SQL Server Web, you can set this parameter to VPC or Classic. If the instance runs other database engines, you must set this parameter to VPC.	Classic
ConnectionMode	string	No	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. NoteIf the RDS instance runs SQL Server 2012, SQL Server 2016, or SQL Server 2017, you must set this parameter to Standard.	Standard
VPCId	string	No	The ID of the VPC to which the instance belongs. NoteThis parameter is available when you set the InstanceNetworkType parameter to VPC.	vpc-*****
VSwitchId	string	No	The ID of the vSwitch. The vSwitch must belong to the zone that is specified by the ZoneId parameter. Note If you set the InstanceNetworkType parameter to VPC, you must specify this parameter. If you specify the ZoneSlaveId1 parameter, you must specify the IDs of two vSwitches for this parameter and separate the IDs with a comma (,).	vsw-*****
PrivateIpAddress	string	No	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.	172.16.XX.XX
UsedTime	string	No	The subscription duration of the instance. 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. NoteIf you set the PayType parameter to Prepaid, you must specify the UsedTime parameter.	2
Period	string	No	The unit of the subscription duration. Valid values: Year: specifies year as the unit of the subscription duration. Month: specifies month as the unit of the subscription duration. NoteIf you set the PayType parameter to Prepaid, you must specify the UsedTime parameter.	Year
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmy*****
DBInstanceStorageType	string	Yes	The storage type that is used by the instance. Valid values: local_ssd: local SSD (recommended). cloud_ssd :standard SSD. This storage type is not recommended. Standard SSDs are no longer available for purchase in some Alibaba Cloud regions. cloud_essd: ESSD of performance level 1 (PL1). cloud_essd2: ESSD of PL2. cloud_essd3: ESSD of PL3. NoteThe 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.	cloud_essd
BusinessInfo	string	No	The additional business information about the instance.	121436975448952
EncryptionKey	string	No	The ID of the key that is used for disk encryption in the region in which the instance resides. If you specify the EncryptionKey parameter, disk encryption is automatically enabled. In this case, you must also specify the RoleARN parameter. Disk encryption cannot be disabled after it is enabled. You can obtain the ID of the key from the Key Management Service (KMS) console. You can also create a key. For more information, see Create a CMK.	0d24*****-da7b-4786-b981-9a164dxxxxxx
RoleARN	string	No	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.	acs:ram::1406xxxxxx:role/aliyunrdsinstanceencryptiondefaultrole
AutoRenew	string	No	Specifies whether to enable auto-renewal for the instance. You must specify this parameter only when the instance uses the subscription billing method. Valid values: true false NoteIf you set the Period parameter to Month, the auto-renewal cycle is one month. If you set the Period parameter to Year, the auto-renewal cycle is one year.	true
Category	string	No	The RDS edition of the instance. Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition AlwaysOn: RDS Cluster Edition for SQL Server Finance: RDS Enterprise Edition Serverless_basic: RDS Serverless Basic Edition	HighAvailability
DedicatedHostGroupId	string	No	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. Note You can call the DescribeDedicatedHostGroups operation to query the details about a dedicated cluster. Note If no dedicated clusters are created, you can call the CreateDedicatedHostGroup operation to create a dedicated cluster.	dhg-4n*****
TargetDedicatedHostIdForMaster	string	No	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. Note You can call the DescribeDedicatedHostGroups operation to query the details about a dedicated cluster. Note If no hosts are created, you can call the CreateDedicatedHost operation to create a host.	i-bp*****1
TargetDedicatedHostIdForSlave	string	No	The ID of the host to which the secondary instance belongs in the specified dedicated cluster. If the instance runs RDS High-availability Edition or RDS Enterprise Edition and 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. Note You can call the DescribeDedicatedHosts operation to query the details about the hosts in a dedicated cluster. Note If no hosts are created, you can call the CreateDedicatedHost operation to create a host.	i-bp*****2
TargetDedicatedHostIdForLog	string	No	The ID of the host to which the logger instance belongs in the specified dedicated cluster. If the instance runs RDS Enterprise Edition and 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. Note You can call the DescribeDedicatedHosts operation to query the details about the hosts in a dedicated cluster. If no hosts are created, you can call the CreateDedicatedHost operation to create a host.	i-bp*****3
DBParamGroupId	string	No	The ID of the parameter template that is used for the instance. You can call the DescribeParameterGroups operation to query ID of the parameter template. NoteIf you want to create an instance that runs MySQL on RDS Basic Edition and uses the X-Engine storage engine, you must call the preceding operation, locate the mysql_xengine_8.0_basic_normal_safe field in the response, find the ID of the required system parameter template, and then use the ID as the value for this parameter. * If you want to create an instance that runs MySQL on RDS High-availability Edition and uses the X-Engine storage engine, you must call the preceding operation, locate the mysql_xengine_8.0_standard_normal_safe field in the response, find the ID of the required system parameter template, and then use the ID as the value for this parameter.	rpg-sys-*****
DBTimeZone	string	No	The time zone of the instance. This parameter takes effect only when you set the Engine parameter to MySQL or PostgreSQL. If you set the Engine parameter 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. For example, you can specify the Asia/Hong_Kong time zone. For more information, see Time zones. If you set the Engine parameter 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. NoteIf the instance is a primary instance, you can specify this parameter. If the instance is a read-only instance, you cannot specify this parameter. A read-only instance inherits the time zone of its primary instance. - If you do not specify this parameter, the system assigns the default time zone of the region in which the instance resides to the instance.	+08:00
DBIsIgnoreCase	string	No	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.	true
TargetMinorVersion	string	No	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`. The following list describes the fields in the example values: rds: The instance runs RDS Basic Edition or 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. NoteYou can call the DescribeDBMiniEngineVersions operation to query the minor engine version. For more information about minor engine versions, see Release notes of minor AliSQL versions. 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`. The following list describes the fields in the example value: 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. NoteIf 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`.	rds_20200229
StorageAutoScale	string	No	Specifies whether to enable automatic storage expansion for the instance. Valid values: Enable. Disable. This is the default value. NoteAfter the instance is created, you can call the ModifyDasInstanceConfig operation to adjust the settings of automatic storage expansion for the instance. For more information, see Configure automatic storage expansion for an ApsaraDB RDS for MySQL instance.	Disable
StorageThreshold	integer	No	The threshold based on which automatic storage expansion is triggered. Unit: percent. Valid values: 10 20 30 40 50 NoteIf you set the StorageAutoScale parameter to Enable, you must specify this parameter.	50
StorageUpperBound	integer	No	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. Valid values: an integer greater than or equal to 0. If you set the StorageAutoScale parameter to Enable, you must also specify this parameter.	2000
DryRun	boolean	No	Specifies whether to perform a precheck before the system creates the instance. Valid values: true: The system prechecks the request and does not create the instance. The system prechecks items such as the request parameters, request format, service limits, and available resources. false: The system sends the request without a precheck. If the request passes verification, the system creates the instance.	false
UserBackupId	string	No	The ID of the backup file. You can call the ListUserBackupFiles operation to query backup files. If you create the instance by using a backup file, you must specify this parameter. NoteYou can specify this parameter 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.	67798*****
Amount	integer	No	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. Note If you want to create multiple ApsaraDB RDS for MySQL instances at a time by using a single request, you can add tags to all the instances by using the Tag.Key parameter and the Tag.Value parameter. After the instances are created, you can manage the instances based on the tags. Note After you submit a request to create multiple ApsaraDB RDS for MySQL instances, this operation returns the TaskId, RequestId, and Message parameters. You can call the DescribeDBInstanceAttribute operation to query the details about an instance. If the value of the Engine parameter is not MySQL and the value of the Amount parameter is greater than 1, this operation fails and returns an error code `InvalidParam.Engine`.	2
CreateStrategy	string	No	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. Atomicity: atomicity. The instances are all created. If one instance cannot be created, none of the instances is created. Partial: non-atomicity. Each instance is independently created. The failure in creating an instance does not affect the creation of the other instances. NoteThe default value of this parameter is Atomicity.	Atomicity
Tag	array	No	An array that consists of details of the tag.
	object	No	The details of the tag.
Key	string	No	The key of the tag. You can use this parameter to add tags to the instance. Note If the specified tag key is an existing key, the system directly adds the tag key to the instance. You can call the ListTagResources operation to query the details about the existing tags. If the specified tag key is not an existing key, the system creates the tag key and adds the tag key to the instance. Note The value of this parameter cannot be an empty string. This parameter must be used together with the Tag.Value parameter.	testkey1
Value	string	No	The tag value that is associated with the specified tag key. You can use this parameter to add tags to the instance. Note If the specified tag value is found in the specified tag key, the system directly adds the tag value to the instance. You can call the ListTagResources operation to query the details about the existing tags. Note If the specified tag value is not found in the specified tag key, the system creates the tag value and adds the tag value to the instance. This parameter must be used together with the Tag.Key parameter.	testvalue1
DeletionProtection	boolean	No	Specifies whether to enable the release protection feature for the instance. true: enables the feature. false: disables the feature. This is the default value.	true
BabelfishConfig	string	No	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: `! @ # $ % ^ & * ( ) _ + - =`. NoteThis parameter applies only to instances that run PostgreSQL. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to 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. NoteThis parameter takes effect only when you create an instance that runs MySQL.
MaxCapacity	double	No	The maximum number of RDS Capacity Units (RCUs). Valid values: 0.5 to 8. NoteThe value of this parameter must be greater than or equal to the value of the MinCapacity property parameter.	8
MinCapacity	double	No	The minimum number of RCUs. Valid values: 0.5 to 8. NoteThe value of this parameter must be less than or equal to the value of the MaxCapacity parameter.	0.5
AutoPause	boolean	No	Specifies whether to enable the smart startup and stop feature for the serverless instance. Valid values: true: enables the feature. false: disables the feature. This is the default value. NoteAfter the smart startup and suspension feature is enabled, if no connections to the instance are established within 10 minutes, the instance is suspended. After a connection to the instance is established, the instance is resumed.	true
SwitchForce	boolean	No	Specifies whether to enable the forced scaling feature for the serverless instance. Valid values: true: enables the feature. false: disables the feature. This is the default value. Note If you set this parameter to true, a transient connection that lasts approximately 1 minute occurs during forced scaling. Process with caution. Note The RCU scaling for a serverless instance immediately takes effect. In some cases, such as the execution of large transactions, the scaling does not immediately take effect. In this case, you can enable this feature to forcefully scale the RCUs of the instance.	false
ConnectionString	string	No	The endpoint of the instance. NoteThe DBInstanceNetType parameter specifies whether the endpoint is internal or public.	rm-uf6wjk5*****.mysql.rds.aliyuncs.com
Port	string	No	You can initialize the port when you create the RDS instance. Valid values: 1000 to 599.	3306

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
DryRunResult	boolean	Indicates whether the request passed the precheck. Valid values: true: The request passed the precheck. false: The request failed the precheck. Note If the system does not perform a precheck, this parameter is not returned. Note If the request failed the precheck, an error is returned.	true
TagResult	boolean	Indicates whether the specified tag is added to the instance. Valid values: true: The specified tag is added to the instance. false: The specified tag fails to be added to the instance. NoteIf you do not add a tag to the instance, this parameter is not returned.	true
RequestId	string	The ID of the request.	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC
ConnectionString	string	The endpoint of the instance. NoteThe DBInstanceNetType parameter indicates whether the endpoint is internal or public.	rm-uf6wjk5*****.mysql.rds.aliyuncs.com
Message	string	The message that indicates whether multiple instances are created. NoteThe parameter is returned only when the value of the Amount parameter is greater than 1.	Batch Create DBInstance Task Is In Process.
DBInstanceId	string	The ID of the instance If the value of the Amount parameter is greater than 1, more than one instance ID is returned. The number of instance IDs that are returned is the same as the value of the Amount parameter. The returned instance IDs are separated by commas (,). For example, if the value of the Amount parameter is 3, three instance IDs are returned. Example: `rm-uf6wjk5***1,rm-uf6wjk5*2,rm-uf6wjk5***3`	rm-uf6wjk5*****
Port	string	The port that is used to connect to the instance. NoteThe DBInstanceNetType parameter indicates whether the port number is internal or public.	3306
TaskId	string	The ID of the task that is run to create multiple instances. Note This parameter is returned only when the value of the Amount parameter is greater than 1. Note The TaskID parameter cannot be used to query a task.	s2365879-a9d0-55af-fgae-f2*****
DryRun	boolean	Indicates that the system prechecks the request before the system creates the instance. Note The return value is fixed as true. Note If the system does not perform a precheck, this parameter is not returned.	true
OrderId	string	The ID of the order.	1007893702*****

NoteIn the latest version of SDK, the default timeout period on the client side is different from the default timeout period on the instance. If you use the latest version of SDK to call this operation, a timeout error may be reported even if this operation is successfully called. To prevent this issue, you can set the ReadTimeout parameter to 20000 before you call this operation.

Examples

Sample success responses

JSONformat

{
  "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	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.	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.
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.	-
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.	The endpoint is duplicate. Specify a different endpoint.
400	InvalidUsedTime	UsedTime can not Less than or equal to zero.	-
400	InvalidUsedTime	UsedTime can not Less than or equal to zero.	-
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.
401	CannotDecreaseEssdPerfLevel	cannot decrease cloud essd performance level.	The storage type change failed the verification check. The storage type of an RDS instance that runs SQL Server with standard SSDs or ESSDs cannot be changed to local SSDs.
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.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-12-22

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	delete Error Codes: 401
	delete Error Codes: 403

2022-09-13

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 403 change
	delete Error Codes: 400
	delete Error Codes: 401

2022-09-13

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 403 change
	delete Error Codes: 400
	delete Error Codes: 401

2022-08-31

The error codes of the API operation change.,The input parameters of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 401
	delete Error Codes: 403
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: ConnectionString

2022-06-22

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	delete Error Codes: 401
	delete Error Codes: 403

2022-03-01

The error codes of the API operation change.,The input parameters of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 401
	delete Error Codes: 403
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: DeletionProtection

2022-03-01

The error codes of the API operation change.,The input parameters of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 401
	delete Error Codes: 403
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: BabelfishConfig