Creating a DB Instance
Function
This API is used to create an RDS single-node DB instance, primary/standby DB instance, or read replica.
- Before calling this API, learn how to authenticate it.
 - Before calling this API, learn about request header parameters.
 
URI
- URI format
 - Parameter description 
     
Table 1 Parameters Parameter
Mandatory
Description
project_id
Yes
Definition
Project ID of a tenant in a region.
To obtain the value, see Obtaining a Project ID.
Constraints
N/A
Range
N/A
Default Value
N/A
 
Request
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         name  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the DB instance name. Instances of the same type can have the same name under the same tenant. Constraints N/A Range 
 Default Value N/A  | 
      
| 
         datastore  | 
       
         Yes  | 
       
         Object  | 
       
         Definition Specifies the database information. For details, see Table 4. Constraints N/A  | 
      
| 
         flavor_ref  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the specification code. Constraints N/A Range The value cannot be empty. For details, see spec_code in Table 3 in section Querying Database Specifications. Default Value N/A  | 
      
| 
         volume  | 
       
         Yes  | 
       
         Object  | 
       
         Definition Specifies instance storage. For details, see Table 7. Constraints N/A  | 
      
| 
         region  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the region ID. Constraints N/A Range Default Value N/A  | 
      
| 
         availability_zone  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the AZ ID. If the DB instance is not a single-node instance, you need to specify an AZ for each node of the instance and separate the AZs with commas (,). For details, see the example. Constraints N/A Range Default Value N/A  | 
      
| 
         vpc_id  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the VPC ID. Constraints N/A Range 
 Default Value N/A  | 
      
| 
         subnet_id  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the network ID of the subnet. Constraints N/A Range 
 Default Value N/A  | 
      
| 
         security_group_id  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the security group which the RDS DB instance belongs to. To obtain this parameter value, use either of the following methods: Constraints N/A Range 
 Default Value N/A  | 
      
| 
         ha  | 
       
         No  | 
       
         Object  | 
       
         Definition Specifies the HA configuration, which is used when you create primary/standby instances. For details, see Table 5. Constraints N/A  | 
      
| 
         configuration_id  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the parameter template ID. Constraints N/A Range For details, see id in Table 3 in section Obtaining a Parameter Template List. Default Value N/A  | 
      
| 
         port  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the database port information. Constraints N/A Range 
 Default Value If this parameter is not set, the default value is as follows: 
  | 
      
| 
         password  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the database password. Constraints N/A Range A database password must be 8 to 32 characters long and contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters. Different DB engines support different special characters. 
 You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking. If the password you provide is regarded as a weak password by the system, you will be prompted to enter a stronger password. Default Value N/A  | 
      
| 
         backup_strategy  | 
       
         No  | 
       
         Object  | 
       
         Definition Specifies the advanced backup policy. For details, see Table 6. Constraints N/A  | 
      
| 
         enterprise_project_id  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the enterprise project ID. Constraints N/A Range Default Value N/A  | 
      
| 
         disk_encryption_id  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the ID of the key used for disk encryption. Constraints N/A Range N/A Default Value This parameter is left blank by default.  | 
      
| 
         data_vip  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the floating IP address of a DB instance. Constraints N/A Range 
 Default Value This parameter is left blank by default.  | 
      
| 
         time_zone  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the UTC time zone. Constraints N/A Range Default Value 
         If this parameter is not specified, the time zone of each engine is as follows: 
          
  | 
      
| 
         restore_point  | 
       
         No  | 
       
         Object  | 
       
         Definition Specifies the restoration information. This parameter is mandatory when data is restored to a new instance. For details, see Table 10. Constraints N/A  | 
      
| 
         tags  | 
       
         No  | 
       
         Array of objects  | 
       
         Definition Specifies the tag list. DB instances are created based on tag keys and values. 
 If you want to create DB instances with multiple tag key-value pairs, separate them with commas (,). A maximum of 20 key-value pairs can be added. For details, see Table 9. Constraints N/A  | 
      
| 
         collation  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the collation of an RDS for SQL Server instance. Constraints This parameter applies only to RDS for SQL Server DB instances. Range For details, see Querying the Available SQL Server Character Set. Default Value N/A  | 
      
| 
         count  | 
       
         No  | 
       
         Integer  | 
       
         Definition Specifies the number of DB instances to be created in a batch. Constraints This parameter is unavailable when you create read replicas. Range 1–50 Default Value N/A  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         name  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the DB instance name. The DB instance name of the same type must be unique for the same tenant. Constraints N/A Range 
 Default Value N/A  | 
      
| 
         flavor_ref  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the specification code. Constraints N/A Range The value cannot be empty. For details, see spec_code in Table 3 in section Querying Database Specifications. Default Value N/A  | 
      
| 
         volume  | 
       
         Yes  | 
       
         Object  | 
       
         Definition Specifies the volume information. For details, see Table 7. Constraints N/A  | 
      
| 
         availability_zone  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the AZ ID. Constraints N/A Range Default Value N/A  | 
      
| 
         disk_encryption_id  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the ID of the key used for disk encryption. Constraints N/A Range N/A Default Value This parameter is left blank by default.  | 
      
| 
         region  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the region ID. Constraints Currently, read replicas can be created only in the same region as that of the primary DB instance. Range Default Value N/A  | 
      
| 
         charge_info  | 
       
         No  | 
       
         Object  | 
       
         Definition Specifies the billing information. For details, see Table 8. Constraints In the EU-Dublin region, both yearly/monthly and pay-per-use billing modes are available. In other regions, only pay-per-use billing is available. RDS for SQL Server does not support yearly/monthly read replicas.  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         type  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the DB engine. Constraints N/A Range 
 Default Value N/A  | 
      
| 
         version  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the database version. Constraints N/A Range 
 For details about supported database versions, see section Querying Version Information About a DB Engine. Default Value N/A  | 
      
| 
         complete_version  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the complete version number. Constraints This parameter is returned only when the DB engine is PostgreSQL. Range N/A Default Value N/A  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         mode  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the primary/standby instance type. Constraints N/A Range HA (case-insensitive) Default Value N/A  | 
      
| 
         replication_mode  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the replication mode for the standby DB instance. Constraints N/A Range 
 
          NOTE: 
          
        
 Default Value N/A  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         start_time  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the backup time window. Automated backups will be triggered during the backup time window. Constraints N/A Range The value cannot be left blank. It must be a valid value in the hh:mm-HH:MM format. The current time is the UTC time. 
 Example value: 
 Default Value N/A  | 
      
| 
         keep_days  | 
       
         No  | 
       
         Integer  | 
       
         Definition Specifies the retention days for specific backup files. Constraints The automated backup policy cannot be disabled for primary/standby DB instances of RDS for SQL Server. Range 0–732 If this parameter is not specified or set to 0, the automated backup policy is disabled. Default Value N/A  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         type  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the storage type. Constraints N/A Range Its value can be any of the following and is case-sensitive: 
 Default Value N/A  | 
      
| 
         size  | 
       
         Yes  | 
       
         Integer  | 
       
         Definition Specifies the volume size. Constraints For read replicas, this parameter is invalid. The volume size is the same as that of the primary DB instance by default. Range 40–4000, in GB. The value must be a multiple of 10. Default Value N/A  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         charge_mode  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the billing mode. Constraints N/A Range 
 Default Value N/A  | 
      
| 
         period_type  | 
       
         No  | 
       
         String  | 
       
         Definition Specifies the subscription type. Constraints This parameter is valid and mandatory if charge_mode is set to prePaid. Range 
 Default Value N/A  | 
      
| 
         period_num  | 
       
         No  | 
       
         Integer  | 
       
         Definition Specifies the subscription period. Constraints This parameter is valid and mandatory if charge_mode is set to prePaid. Range 
 Default Value N/A  | 
      
| 
         is_auto_renew  | 
       
         No  | 
       
         boolean  | 
       
         Definition Specifies whether automatic renewal is enabled for yearly/monthly DB instances. The renewal period is the same as the original period and the order will be automatically paid. Constraints N/A Range 
 Default Value false  | 
      
| 
         is_auto_pay  | 
       
         No  | 
       
         boolean  | 
       
         Definition Specifies whether the order will be automatically paid after yearly/monthly DB instances are created. This parameter does not affect the payment mode of automatic renewal. Constraints N/A Range 
 Default Value false  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         key  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the tag key. Constraints N/A Range The value must consist of 1 to 128 Unicode characters. It can contain letters, digits, spaces, and special characters _.:=+-@(). However, it cannot start or end with a space, or start with _sys_. Default Value N/A  | 
      
| 
         value  | 
       
         Yes  | 
       
         String  | 
       
         Definition Specifies the tag value. Constraints N/A Range It can be left blank or contain a maximum of 255 Unicode characters. It can contain letters, digits, spaces, and special characters _.:=+-@(). Default Value N/A  | 
      
Example Request
- Create an RDS for MySQL single-node instance. 
     
{ "name": "rds-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "aaa", "availability_zone": "bbb", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 8635, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "postPaid" }, "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg" "time_zone": "UTC+04:00" } 
- Create an RDS for MySQL primary/standby instance. 
     
{ "name": "rds-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "ha", "replication_mode": "semisync" }, "flavor_ref": "rds.mysql.s1.large.ha", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "aaa", "availability_zone": "bbb,ccc", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 8635, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "postPaid" }, "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg" } 
- Create an RDS for MySQL read replica. 
     
{ "name": "rds-instance-rep2", "replica_of_id": "afdsad-fds-fdsagin01", "flavor_ref": "rds.mysql.s1.large.rr", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "aaa", "availability_zone": "bbb" } 
Response
- Normal response 
     
Table 11 Parameters Parameter
Type
Description
instance
Object
Definition
Indicates the DB instance information.
For details, see Table 12.
job_id
String
Definition
Indicates the ID of the DB instance creation task.
Range
N/A
order_id
String
Definition
Indicates the order ID. This parameter is returned for the creation of a yearly/monthly DB instance.
Range
N/A
Table 12 instance field data structure description Parameter
Type
Description
id
String
Definition
Indicates the DB instance ID.
Range
N/A
name
String
Definition
Indicates the DB instance name. DB instances of the same type can have same names under the same tenant.
Range
N/A
status
String
Definition
Indicates the DB instance status.
Range
For example, BUILD indicates that the DB instance is being created.
datastore
Object
Definition
Indicates the database information.
For details, see Table 13.
ha
Object
Definition
Indicates the HA configuration parameters. This parameter is returned only when primary/standby DB instances are created.
For details, see Table 14.
configuration_id
String
Definition
Indicates the parameter template ID. This parameter is returned only when a custom parameter template is used during DB instance creation.
Range
N/A
port
String
Definition
Indicates the database port.
Range
Same as the request parameter.
backup_strategy
Object
Definition
Indicates the automated backup policy.
For details, see Table 15.
enterprise_project_id
String
Definition
Indicates the project ID.
Range
N/A
disk_encryption_id
String
Definition
Indicates the ID of the key used for disk encryption.
Range
This parameter is available only when you specify this parameter during instance creation. By default, this parameter is left blank.
flavor_ref
String
Definition
Indicates the specification code.
Range
The value cannot be empty. For details, see spec_code in Table 3 in section Querying Database Specifications.
volume
Object
Definition
Indicates the volume information.
For details, see Table 16.
region
String
Definition
Indicates the region ID.
Range
N/A
availability_zone
String
Definition
Indicates the AZ ID.
Range
N/A
vpc_id
String
Definition
Indicates the VPC ID.
Range
- Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.
 - Method 2: See the "Querying VPCs" section in the Virtual Private Cloud API Reference.
 
subnet_id
String
Definition
Indicates the network ID of the subnet.
Range
- Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
 - Method 2: See the "Querying Subnets" section in the Virtual Private Cloud API Reference.
 
security_group_id
String
Definition
Indicates the security group which the RDS DB instance belongs to. To obtain this parameter value, use either of the following methods:
Range
- Method 1: Log in to VPC console. Choose Access Control > Security Groups in the navigation pane. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
 - Method 2: See the "Querying Security Groups" section in the Virtual Private Cloud API Reference.
 
charge_info
Object
Definition
Indicates the billing information.
For details, see Table 17.
collation
String
Definition
Indicates the collation set for RDS for SQL Server.
Range
N/A
restore_point
Object
Definition
Indicates the restoration information. This parameter is mandatory when data is restored to a new instance.
For details, see Table 18.
Table 13 datastore field data structure description Parameter
Type
Description
type
String
Definition
Indicates the DB engine.
Range
- MySQL
 - PostgreSQL
 - SQLServer
 
version
String
Definition
Indicates the database version.
Range
For details about supported database versions, see section Querying Version Information About a DB Engine.
Table 14 ha field data structure description Parameter
Type
Description
mode
String
Definition
Indicates the primary/standby instance type.
Range
Ha
replication_mode
String
Definition
Indicates the replication mode for the standby DB instance. This parameter is valid only when the instance is an HA instance.
Range
- For RDS for MySQL, the value is async or semisync.
 - For RDS for PostgreSQL, the value is async or sync.
 - For RDS for SQL Server, the value is sync.
 
NOTE:- async indicates the asynchronous replication mode.
 - semisync indicates the semi-synchronous replication mode.
 - sync indicates the synchronous replication mode.
 
Table 15 backupStrategy field data structure description Parameter
Type
Description
start_time
String
Definition
Indicates the backup time window. Automated backups will be triggered during the backup time window.
Range
The value cannot be left blank. It must be a valid value in the hh:mm-HH:MM format. The current time is the UTC time.
- The HH value must be 1 greater than the hh value.
 - The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45.
 
Example value:
- 08:15-09:15
 - 23:00-00:00
 
If backup_strategy in the request body is empty, 02:00-03:00 is returned for start_time by default.
keep_days
Integer
Definition
Indicates the retention days for specific backup files.
Range
0–732 If this parameter is not specified or set to 0, the automated backup policy is disabled.
If backup_strategy in the request body is empty, 7 is returned for keep_days by default.
Table 16 volume field data structure description Parameter
Type
Description
type
String
Definition
Storage type.
Range
The value is case-sensitive.
- ULTRAHIGH: ultra-high I/O storage.
 - CLOUDSSD: cloud SSD storage.
 - ESSD: extreme SSD storage.
 
size
Integer
Definition
Storage capacity.
Range
40–4000, in GB. The value must be a multiple of 10.
Table 17 chargeInfo field data structure description Parameter
Type
Description
charge_mode
String
Definition
Indicates the billing information.
Range
N/A
period_num
Integer
Definition
Indicates the subscription period, which is calculated by month.
This parameter is valid when charge_mode is set to prePaid (creating yearly/monthly DB instances).
Range
N/A
Table 18 restore_point field data structure description Parameter
Type
Description
instance_id
String
Definition
Specifies the source instance ID.
Range
N/A
type
String
Definition
Specifies the restoration mode.
Range
- backup: Data is restored using backups.
 - timestamp: Data is restored to a point in time.
 
backup_id
String
Definition
Specifies the ID of the backup to be restored.
Range
N/A
restore_time
Integer
Definition
Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.
Range
N/A
database_name
Map<String,String>
Definition
This parameter is supported only for Microsoft SQL Server databases. If this parameter is specified, you can restore specific databases and rename new databases.
Range
N/A
 
- Example normal response 
     
RDS for MySQL single-node instance created.
{ "instance": { "id": "dsfae23fsfdsae3435in01", "name": "trove-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "aaa", "availability_zone": "bbb", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": "8635", "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 3 }, "configuration_id": "452408-44c5-94be-305145fg", "charge_info": { "charge_mode": "postPaid" } }, "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" }RDS for MySQL primary/standby instance created.
{ "instance":{ "id": "dsfae23fsfdsae3435in01", "name": "trove-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "ha", "replication_mode": "semisync" }, "flavor_ref": "rds.mysql.s1.large.ha", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "aaa", "availability_zone": "bbb,ccc", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": "8635", "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 3 }, "configuration_id": "452408-44c5-94be-305145fg", "charge_info": { "charge_mode": "postPaid" }, }, "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" }RDS for MySQL read replica created.
{ "instance":{ "id": "dsfae23fsfdsae3435in01", "name": "trove-instance-rep2", "flavor_ref": "rds.mysql.s1.large.rr", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "aaa", "availability_zone": "bbb", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": "8635", "configuration_id": "452408-44c5-94be-305145fg" }, "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" } - Abnormal response 
     
For details, see Abnormal Request Results.
 
Status Code
- Normal
 - Abnormal 
     
For details, see Status Codes.
 
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.