Help Center> Relational Database Service> API Reference> API v3 (Recommended)> DB Instance Management> Creating a DB Instance

Updated on 2024-03-28 GMT+08:00

View PDF

Creating a DB Instance

Function

This API is used to create a single RDS DB instance, primary/standby DB instance, or read replica.

Before calling an API, you need to understand the API in Authentication.

URI

URI format
POST /v3/{project_id}/instances

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

**Table 2** Parameters (creating single, primary/standby, and cluster instances)
Parameter	Mandatory	Type	Description
name	Yes	String	Specifies the DB instance name. Instances of the same type can have the same name under the same tenant. RDS for MySQL: The DB instance name must be 4 to 64 long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), periods (.), and underscores (_). RDS for PostgreSQL and RDS for SQL Server: The DB instance name must be 4 to 64 long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).
datastore	Yes	Object	Specifies the database information. For details, see Table 4.
flavor_ref	Yes	String	Specifies the specification code. The value cannot be empty. For details, see spec_code in Table 3 in Querying Database Specifications.
volume	Yes	Object	Specifies the volume information. For details, see Table 7.
region	Yes	String	Specifies the region ID.
availability_zone	Yes	String	Specifies the AZ ID. If the DB instance is not a single instance, you need to specify an AZ for each node of the instance and separate the AZs with commas (,). For details, see the example.
vpc_id	Yes	String	Specifies the VPC ID. To obtain this parameter value, use either of the following methods: Method 1: Log in to VPC console and view the VPC ID in the VPC details. Method 2: See the "Querying VPCs" section in the Virtual Private Cloud API Reference.
subnet_id	Yes	String	Specifies the network ID. To obtain this parameter value, use either of the following methods: 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	Yes	String	Specifies the security group which the RDS DB instance belongs to. To obtain this parameter value, use either of the following methods: Method 1: Log in to VPC console. Choose Access Control > Security Groups in the navigation pane on the left. 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.
ha	No	Object	Specifies the HA configuration, which is used when you create primary/standby instances. For details, see Table 5.
configuration_id	No	String	Specifies the parameter template ID. For details, see id in Table 3 in section Obtaining a Parameter Template List.
port	No	String	Specifies the database port information. RDS for MySQL instances can use database ports 1024 to 65535, excluding 12017 and 33071, which are reserved for RDS system use. RDS for PostgreSQL instances can use database ports 2100 to 9500. If this parameter is not set, the default value is as follows: RDS for MySQL: 3306 RDS for PostgreSQL: 5432
password	No	String	Specifies the database password. Valid value: 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. RDS for MySQL: ~!@#$%^-_=+?,()& RDS for PostgreSQL: ~!@#%^-_=+?, 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.
backup_strategy	No	Object	Specifies the advanced backup policy. For details, see Table 6.
disk_encryption_id	No	String	Specifies the key ID for disk encryption. The default value is empty.
data_vip	No	String	Specifies the floating IP address of a DB instance. You can use the following methods to obtain the floating IP address: Method 1: Log in to the VPC console and click the target subnet on the Subnets page. View the subnet CIDR block and select an IP address that is not in use. Method 2: See the "Querying Subnets" section in the Virtual Private Cloud API Reference.
time_zone	No	String	Specifies the UTC time zone. If this parameter is not specified, the time zone of each engine is as follows: MySQL: uses UTC by default. PostgreSQL: uses UTC by default. If this parameter is specified, the value range is from UTC-12:00 to UTC+12:00 on the hour. For example, the parameter can be UTC+08:00 rather than UTC+08:30.
tags	No	Array of objects	Specifies the tag list. DB instances are created based on tag keys and values. {key} indicates the tag key. It must be unique and cannot be empty. {value} indicates the tag value, which can be empty. 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.
count	No	Integer	Specifies the number of DB instances to be created in a batch. Value range: 1 to 50 This parameter is unavailable when you create read replicas.

**Table 3** Parameters (creating read replicas)
Parameter	Mandatory	Type	Description
name	Yes	String	Specifies the DB instance name. The DB instance name of the same type must be unique for the same tenant. Valid value: RDS for MySQL: The DB instance name must be 4 to 64 long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), periods (.), and underscores (_). RDS for PostgreSQL and RDS for SQL Server: The DB instance name must be 4 to 64 long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).
flavor_ref	Yes	String	Specifies the specification code. The value cannot be empty. For details, see spec_code in Table 3 in section Querying Database Specifications.
volume	Yes	Object	Specifies the volume information. For details, see Table 7.
availability_zone	Yes	String	Specifies the AZ ID.
disk_encryption_id	No	String	Specifies the key ID for disk encryption. The default value is empty.
region	No	String	Specifies the region ID. Currently, read replicas can be created only in the same region as that of the primary DB instance.
charge_info	No	Object	Specifies the billing information. For details, see Table 8. NOTE: To create RDS for MySQL and RDS for PostgreSQL read replicas billed on a yearly/monthly basis, contact customer service to apply for the required permissions. 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.

**Table 4** datastore field data structure description
Parameter	Mandatory	Type	Description
type	Yes	String	Specifies the DB engine. Value: MySQL PostgreSQL
version	Yes	String	Specifies the database version. For RDS for MySQL, 5.7 and 8.0 are supported. Example value: 5.7 For RDS for PostgreSQL, 9.5, 9.6, 10, 11, 12, 13, 14, and 15 are supported. Example value: 9.6 For details about supported database versions, see section Querying Version Information About a DB Engine.

**Table 5** ha field data structure description
Parameter	Mandatory	Type	Description
mode	Yes	String	Specifies the primary/standby instance type. The value is Ha (case-insensitive).
replication_mode	Yes	String	Specifies the replication mode for the standby DB instance. Value: For RDS for MySQL, the value is async or semisync. For RDS for PostgreSQL, the value is async or sync. NOTE: async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode.

**Table 6** backup_strategy field data structure description
Parameter	Mandatory	Type	Description
start_time	Yes	String	Specifies the backup time window. Automated backups will be triggered during the backup time window. The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. 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
keep_days	No	Integer	Specifies the retention days for specific backup files. The value range is from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled.

**Table 7** volume field data structure description
Parameter	Mandatory	Type	Description
type	Yes	String	Specifies the volume type. Its value can be any of the following and is case-sensitive: ULTRAHIGH: ultra-high I/O storage.
size	Yes	Integer	Specifies the volume size. Its value must be a multiple of 10 and the value range is from 40 GB to 4,000 GB. NOTE: For read replicas, this parameter is invalid. The volume size is the same as that of the primary DB instance by default.

**Table 8** charge_info field data structure description
Parameter	Mandatory	Type	Description
charge_mode	Yes	String	Specifies the billing mode. Valid value: prePaid: indicates the yearly/monthly billing mode. postPaid: indicates the pay-per-use billing mode.
period_type	No	String	Specifies the subscription period. Valid value: month: indicates that the subscription unit is month. year: indicates that the subscription unit is year. NOTE: This parameter is valid and mandatory if charge_mode is set to prePaid.
period_num	No	Integer	This parameter is valid and mandatory if charge_mode is set to prePaid. Valid value: When period_type is set to month, the parameter value ranges from 1 to 9. When period_type is set to year, the parameter value is 1.

**Table 9** tags field data structure description
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. It must consist of 1 to 128 Unicode characters, including letters, digits, spaces, and special characters _.:=+-@. However, it cannot start or end with a space, or start with _sys_.
value	Yes	String	Specifies the tag value. It can be left blank or contain a maximum of 255 Unicode characters, including letters, digits, spaces, and the following special characters: _.:=+-@

Example Request

Creating an RDS for MySQL single instance

{
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "MySQL",
		"version": "5.7"
	},
	"flavor_ref": "rds.mysql.s1.large",
	"volume": {
		"type": "ULTRAHIGH",
		"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"
}

Creating a 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": "ULTRAHIGH",
		"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"
        
_}

Creating a read replica

{
	"name": "rds-instance-rep2",
	"replica_of_id": "afdsad-fds-fdsagin01",
	"flavor_ref": "rds.mysql.s1.large.rr",
	"volume": {
		"type": "ULTRAHIGH",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"region": "aaa",
	"availability_zone": "bbb"
}

Response

Normal response

**Table 10** Parameter description
Parameter	Type	Description
instance	Object	Indicates the DB instance information. For details, see Table 11.
job_id	String	Indicates the ID of the DB instance creation task.

**Table 11** instance field data structure description
Parameter	Type	Description
id	String	Indicates the DB instance ID.
name	String	Indicates the DB instance name. DB instances of the same type can have same names under the same tenant.
status	String	Indicates the DB instance status. For example, BUILD indicates that the DB instance is being created.
datastore	Object	Indicates the database information. For details, see Table 12.
ha	Object	Indicates the HA configuration parameters. This parameter is returned only when primary/standby DB instances are created. For details, see Table 13.
configuration_id	String	Indicates the parameter template ID. This parameter is returned only when a custom parameter template is used during DB instance creation.
port	String	Indicates the database port, which is the same as the request parameter.
backup_strategy	Object	Indicates the automated backup policy. For details, see Table 14.
disk_encryption_id	String	Indicates the key ID for disk encryption. By default, this parameter is empty and is returned only when it is specified during the DB instance creation.
flavor_ref	String	Indicates the specification code. The value cannot be empty. For details, see spec_code in Table 3 in section Querying Database Specifications.
volume	Object	Indicates the volume information. For details, see Table 15.
region	String	Indicates the region ID.
availability_zone	String	Indicates the AZ ID.
vpc_id	String	Indicates the VPC ID. To obtain this parameter value, use either of the following methods: Method 1: Log in to VPC console and view the VPC ID in the VPC details. Method 2: See the "Querying VPCs" section in the Virtual Private Cloud API Reference.
subnet_id	String	Indicates the network ID. To obtain this parameter value, use either of the following methods: 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	Indicates the security group which the RDS DB instance belongs to. To obtain this parameter value, use either of the following methods: Method 1: Log in to VPC console. Choose Access Control > Security Groups in the navigation pane on the left. 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	Indicates the billing information. For details, see Table 16.

**Table 12** datastore field data structure description
Parameter	Type	Description
type	String	Indicates the DB engine. Value: MySQL PostgreSQL
version	String	Indicates the database version. For details about supported database versions, see section Querying Version Information About a DB Engine.

**Table 13** ha field data structure description
Parameter	Type	Description
mode	String	Indicates the primary/standby instance type. The value is Ha.
replication_mode	String	Indicates the replication mode for the standby DB instance. This parameter is valid only when the instance is an HA instance. Value: For RDS for MySQL, the value is async or semisync. For RDS for PostgreSQL, the value is async or sync. NOTE: async indicates the asynchronous replication mode. semisync indicates the semi-synchronous replication mode. sync indicates the synchronous replication mode.

**Table 14** backupStrategy field data structure description
Parameter	Type	Description
start_time	String	Indicates the backup time window. Automated backups will be triggered during the backup time window. The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. 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	Indicates the retention days for specific backup files. The value range is from 0 to 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 15** volume field data structure description
Parameter	Type	Description
type	String	Indicates the volume type. Its value can be any of the following and is case-sensitive: ULTRAHIGH: ultra-high I/O storage.
size	Integer	Indicates the volume size. Its value range is from 40 GB to 4,000 GB. The value must be a multiple of 10.

**Table 16** chargeInfo field data structure description
Parameter	Type	Description
charge_mode	String	Indicates the billing information.
period_num	Integer	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).

Example normal response

Creating an RDS for MySQL single instance:

{
	"instance": {
		"id": "dsfae23fsfdsae3435in01",
		"name": "trove-instance-rep2",
		"datastore": {
			"type": "MySQL",
			"version": "5.7"
		},
		"flavor_ref": "rds.mysql.s1.large",
		"volume": {
			"type": "ULTRAHIGH",
			"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"
}

Creating a primary/standby instance:

{
  "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": "ULTRAHIGH", 
               "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" 
}

Creating a read replica:

{
  "instance":{ 
            "id": "dsfae23fsfdsae3435in01",
            "name": "trove-instance-rep2", 
            "flavor_ref": "rds.mysql.s1.large.rr",
             "volume": { 
               "type": "ULTRAHIGH", 
               "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
202
Abnormal
For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management

Previous topic: DB Instance Management

Next topic: Stopping an Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel