Restoring Data to a New DB Instance_Backup and Restoration_API v3 (Recommended)_API Reference

Function

This API is used to restore data to a new DB instance.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about the request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:instance:create	write	-	-	-	-

Constraints

The DB engine of the original DB instance must be the same as that of the target DB instance. For example, if the original DB instance is running MySQL, the target DB instance must also run MySQL.
The constraints on the original and target DB instances are as follows:
- For RDS for MySQL and RDS for PostgreSQL, the DB engine versions of the original and target DB instances must be the same.
- For RDS for SQL Server, the time zones of the original and target DB instances must be the same. Otherwise, data inconsistency may occur.
For RDS for MySQL and RDS for PostgreSQL, the total disk size of the target DB instance must be at least equal to that of the original DB instance.

URI

URI format
POST /v3/{project_id}/instances

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Specifies the DB instance name. DB instances of the same type can have same names under the same tenant. Constraints N/A Range RDS for MySQL: The DB instance name must be 4 to 64 bytes 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 bytes long, start with a letter, and contain only letters (case-sensitive), digits, hyphens (-), and underscores (_). Default Value N/A
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. RDS for MySQL allows special characters ~!@#$%^-_=+?,()& RDS for SQL Server allows special characters ~!@#$%^-_+?, RDS for PostgreSQL allows special characters ~!@#%^-_=+?, You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking. Default Value* If this parameter is not specified, you can reset the password after the instance is created.
flavor_ref	Yes	String	Definition Specifies the specification code. Constraints N/A Range The value cannot be left blank. For details, see spec_code in the response in 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. 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. The AZ ID can be obtained from the response returned after the API in Querying Database Specifications is called. Constraints N/A Range Default Value N/A
restore_point	Yes	Object	Definition Specifies the restoration information. For details, see Table 8. Constraints N/A
datastore	No	Object	Definition Specifies database information. This parameter is used for RDS for SQL Server DB instances only and is mandatory for cross-version restoration to new DB instances. For details, see Table 4. For details about versions for RDS for SQL Server restoration, see Table 5. Constraints N/A
ha	No	Object	Definition Specifies the HA configuration parameters, which are used when creating primary/standby DB instances. For details, see Table 3. 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 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. For RDS for SQL Server 2022 Enterprise Edition, 2022 Standard Edition, 2022 Web Edition, 2019 Enterprise Edition, 2019 Standard Edition, 2019 Web Edition, 2017 Enterprise Edition, 2017 Standard Edition, and 2017 Web Edition, the port number can be set to 1433 or 2100 to 9500 (excluding 5050, 5353, 5355, 5985, and 5986). For other editions, the port number can be set to 1433 or 2100 to 9500 (excluding 5355, 5985, and 5986). Default Value If this parameter is not set, the default value is as follows: RDS for MySQL: 3306 RDS for PostgreSQL: 5432 RDS for SQL Server: 1433
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 For details, see id in the enterprise_project field data structure table in Querying Enterprise Projects of the Enterprise Management API Reference. 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 This parameter is mandatory for RDS for SQL Server and RDS for PostgreSQL. Range To obtain the value, see Regions and Endpoints. Default Value N/A
vpc_id	No	String	Definition Specifies the VPC ID. Constraints This parameter is mandatory for RDS for SQL Server and RDS for PostgreSQL. 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. Default Value N/A
subnet_id	No	String	Definition Specifies the subnet ID. Constraints This parameter is mandatory for RDS for SQL Server and RDS for PostgreSQL. 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. Default Value N/A
data_vip	No	String	Definition Specifies the floating IP address of a DB instance. Currently, only IPv4 addresses are supported. Constraints N/A Range 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. Default Value This parameter is left blank by default.
security_group_id	No	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 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. To use multiple security groups for an RDS for MySQL instance, submit a service ticket to apply for required permissions. You can add up to 10 security group IDs for each instance and separate them with commas (,). Default Value N/A
charge_info	No	Object	Definition Specifies the billing information, which is yearly/monthly or pay-per-use (default setting). For details, see Table 9. Constraints Only RDS for MySQL and RDS for SQL Server supports restoration of yearly/monthly DB instances to new instances.
time_zone	No	String	Definition Specifies the UTC time zone. Constraints N/A Range If this parameter is specified for MySQL or PostgreSQL, the value range is from UTC-12:00 to UTC+12:00 on the hour. For example, the value can be UTC+08:00 rather than UTC+08:30. Default Value 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. Microsoft SQL Server: uses UTC by default.
dsspool_id	No	String	Definition Specifies the DSS pool ID of DeC users. Constraints The DSS pool configured for each AZ is different. When DeC users create DB instances other than single-node instances or read replicas, DSS pool IDs must be specified for all nodes of the DB instances and must be separated by commas (,). Range Method 1: Log in to the DSS console, view the DSS pool list, and select the desired DSS ID in the AZ. Method 2: Query the DSS pool ID using the DSS API. For details, see Obtaining Details of DSS Storage Pools. Default Value 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
tags	No	Array of objects	Definition Specifies the tag list. Each DB instance can be associated with tag key-value pairs while being created. {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 keys and values, separate them with commas (,). A maximum of 20 key–value pairs can be added for a DB instance. For details, see Table 10. Constraints N/A
dry_run	No	Boolean	Definition Specifies whether DB instances will not be created after the request is checked. Constraints This parameter is supported with the MySQL DB engine only. Range true: DB instances will not be created after the request is checked. If the check is successful, status code 202 is returned. If the check fails, an error code is returned. For details, see Error Codes. false: DB instances will be created after the check is successful. Default Value N/A
is_auto_upgrade	No	Boolean	Definition Whether to enable automatic minor version upgrade. Constraints This parameter is available only for RDS for PostgreSQL DB instances. Range true: Automatic minor version upgrade is enabled. false: Automatic minor version upgrade is disabled. Default Value false

**Table 3** ha field data structure description
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 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. Default Value N/A

**Table 4** datastore field data structure description
Parameter	Mandatory	Type	Description
type	Yes	String	Definition Specifies the DB engine. Constraints N/A Range SQLServer Default Value N/A
version	Yes	String	Definition Specifies the database version. Constraints N/A Range For RDS for SQL Server, only 2019 Enterprise Edition, 2019 Standard Edition, 2019 Web Edition, 2017 Enterprise Edition, 2017 Standard Edition, 2017 Web Edition, 2014 Standard Edition, 2014 Enterprise Edition, 2016 Standard Edition, 2016 Enterprise Edition, 2012 Enterprise Edition, 2012 Standard Edition, 2012 Web Edition, 2014 Web Edition, and 2016 Web Edition are supported. Example value: 2014_SE 2008 R2 Enterprise Edition and 2008 R2 Web Edition are only for installed base operations. For details about supported database versions, see Querying Version Information About a DB Engine. Default Value N/A

**Table 5** Version mapping for RDS for SQL Server restoration
Original	Restore To
2008 R2 Standard Edition	2012 Standard Edition 2012 Enterprise Edition 2014 Standard Edition 2014 Enterprise Edition 2016 Standard Edition 2016 Enterprise Edition 2017 Standard Edition 2017 Enterprise Edition
2012 Web Edition	2012 Web Edition 2012 Standard Edition 2012 Enterprise Edition 2014 Web Edition 2014 Standard Edition 2014 Enterprise Edition 2016 Web Edition 2016 Standard Edition 2016 Enterprise Edition 2017 Web Edition 2017 Standard Edition 2017 Enterprise Edition
2012 Standard Edition	2012 Standard Edition 2012 Enterprise Edition 2014 Standard Edition 2014 Enterprise Edition 2016 Standard Edition 2016 Enterprise Edition 2017 Standard Edition 2017 Enterprise Edition
2012 Enterprise Edition	2012 Enterprise Edition 2014 Enterprise Edition 2016 Enterprise Edition 2017 Enterprise Edition
2014 Standard Edition	2014 Standard Edition 2014 Enterprise Edition 2016 Standard Edition 2016 Enterprise Edition 2017 Standard Edition 2017 Enterprise Edition
2014 Enterprise Edition	2014 Enterprise Edition 2016 Enterprise Edition 2017 Enterprise Edition
2016 Standard Edition	2016 Standard Edition 2016 Enterprise Edition 2017 Standard Edition 2017 Enterprise Edition
2016 Enterprise Edition	2016 Enterprise Edition 2017 Enterprise Edition
2017 Web Edition	2017 Web Edition 2017 Standard Edition 2017 Enterprise Edition
2017 Standard Edition	2017 Standard Edition 2017 Enterprise Edition
2017 Enterprise Edition	2017 Enterprise Edition

**Table 6** backup_strategy field data structure description
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. 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 Default Value N/A
keep_days	No	Integer	Definition Specifies the retention days for specific backup files. Constraints N/A Range 0–732. If this parameter is not specified or set to 0, the automated backup policy is disabled. To extend the retention period, contact customer service. Automated backups can be retained for up to ten years. Default Value N/A

**Table 7** volume field data structure description
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: ULTRAHIGH: ultra-high I/O storage. CLOUDSSD: cloud SSD storage. This storage type is supported only with general-purpose and dedicated DB instances. ESSD: extreme SSD storage. Default Value N/A
size	Yes	Integer	Definition Specifies the storage space. Constraints The storage of the new DB instance must be at least equal to that of the original DB instance for RDS for MySQL. RDS for PostgreSQL: Restoration based on a full backup file: The storage of the new DB instance must be at least equal to the value of min_data_volume_capacity_for_restore returned by the API for obtaining backups. Restoration to a point in time: The storage of the new DB instance must be at least equal to that of the original DB instance. Range 40–4000, in GB. The value must be a multiple of 10. Default Value N/A

**Table 8** restore_point field data structure description
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Definition Specifies the DB instance ID. Constraints N/A Range N/A Default Value N/A
type	Yes	String	Definition Specifies the restoration mode. Constraints N/A Range backup: indicates restoration from backup files. In this mode, backup_id is mandatory when type is not mandatory. timestamp: indicates point-in-time restoration. In this mode, restore_time is mandatory when type is mandatory. Default Value N/A
backup_id	No	String	Definition Specifies the ID of the backup used to restore data. Constraints This parameter must be specified when backups are used for restoration. When type is not mandatory, backup_id is mandatory. Range N/A Default Value N/A
restore_time	No	Integer	Definition Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC. Constraints When type is mandatory, restore_time is mandatory. Range N/A Default Value N/A
database_name	No	Map<String, String>	Definition Specifies the database name. Constraints This parameter applies only to Microsoft SQL Server databases. If this parameter is specified, you can restore all or specific databases and rename new databases. Range You can enter multiple new database names and separate them with commas (,). The new database names can contain but cannot be the same as the original database names. Note the following when you are specifying new database names: New database names must be different from the original database names. If they are left blank, the original database names will be used for restoration by default. Check whether new database names are case sensitive based on the character set selected during instance creation and make sure each new database name is unique. New database names must be different from any database names on the original DB instance. The total number of new databases cannot exceed the database quota specified by rds_databases_quota. New database names cannot contain the following fields (case-insensitive): rdsadmin, master, msdb, tempdb, model, and resource. New database names must consist of 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). If you want to restore data to multiple new databases, separate them with commas (,). Example: "database_name":{"Original database name":"New database name"} Correct example: "database_name":{"A":"A,A1,A2","B":"B1,B2","C":""} Wrong example: "database_name":{"A":"A","B":"B1,B2","C":"B1,C1","D":"D1,d1"}, Error causes are as follows: The new database name (A) is the same as the original database name (A). The new database name (B1) is not unique. When the database name is case insensitive, the database names D1 and d1 conflict. CAUTION: Before the restoration, make sure that the size of the restored data does not exceed the purchased disk capacity. Default Value If this parameter is not specified, all databases are restored by default.

**Table 9** charge_info field data structure description
Parameter	Mandatory	Type	Description
charge_mode	Yes	String	Definition Specifies the billing mode. Constraints N/A Range prePaid: indicates the yearly/monthly billing mode. postPaid: indicates the pay-per-use billing mode. 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 month: indicates that the subscription unit is month. year: indicates that the subscription unit is year. Default Value N/A
period_num	No	Integer	Definition Specifies the subscription period. Constraints Specifies the subscription period. This parameter is valid and mandatory if charge_mode is set to prePaid. Range 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 ranges from 1 to 3. 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 true: indicates that automatic renewal is enabled. false: indicates that automatic renewal is disabled. The default value is false. 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 true: indicates the order will be automatically paid. false: indicates the order will be manually paid. The default value is false. Default Value false

**Table 10** tags field data structure description
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

Restore a MySQL backup to a new DB instance.

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances

{
	"name": "targetInst",
	"availability_zone": "bbb,ccc",
	"ha": {
		"mode": "ha",
		"replication_mode": "async"
	},
	"flavor_ref": "rds.mysql.s1.large",
	"volume": {
		"type": "CLOUDSSD",
		"size": 40
	},
        "region": "aaa",
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.147",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"backup_strategy": {
		"keep_days": 2,
		"start_time": "19:00-20:00"
	},
	"password": "Demo@12345678",
	"configuration_id": "52e86e87445847a79bf807ceda213165pr01",
	"enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
	"time_zone": "UTC+04:00",
	"restore_point": {
		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
		"type": "backup",
		"backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe"
	}
}

Restore some databases to a new DB instance from an RDS for SQL Server backup.

{
	"name": "targetInst",
        "datastore": {
		"type": "SQLServer",
		"version": "2014_SE"
	},
	"availability_zone": "bbb,ccc",
	"ha": {
		"mode": "ha",
		"replication_mode": "sync"
	},
	"flavor_ref": "rds.mssql.2014.se.s3.xlarge.2.ha",
	"volume": {
		"type": "ULTRAHIGH",
		"size": 40
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.147",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"backup_strategy": {
		"keep_days": 2,
		"start_time": "19:00-20:00"
	},
       "charge_info": {
	       "charge_mode": "prePaid",		
               "period_type": "month",
               "period_num": 1,
               "is_auto_renew": false,
               "is_auto_pay": true
       },
	"password": "Demo@12345678",
	"configuration_id": "52e86e87445847a79bf807ceda213165pr04",
	"enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
	"time_zone": "UTC+04:00",
        "collation": "Cyrillic_General_CI_AS",
	"restore_point": {
		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04",
		"type": "backup",
		"backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
		"database_name": {
			"db1": "dbtest1,dbtest2",
			"db2": "db2,db002",
                        "db3": ""
		}
	}
}

Restore data of an RDS for MySQL instance to a specific point in time.

{
	"name": "targetInst",
	"availability_zone": "bbb,ccc",
	"ha": {
		"mode": "ha",
		"replication_mode": "async"
	},
	"flavor_ref": "rds.mysql.s1.large",
	"volume": {
		"type": "CLOUDSSD",
		"size": 40
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"data_vip": "192.168.0.147",
	"backup_strategy": {
		"keep_days": 2,
		"start_time": "19:00-20:00"
	},
	"password": "Demo@12345678",
	"configuration_id": "52e86e87445847a79bf807ceda213165pr01",
	"enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
	"time_zone": "UTC+04:00",
	"restore_point": {
		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
		"type": "timestamp",
		"restore_time": 1532001446987
	}
}

Restore some databases of an RDS for SQL Server instance to a specific point in time.

{
	"name": "targetInst",
        "datastore": {
		"type": "SQLServer",
		"version": "2014_SE"
	},
	"availability_zone": "bbb,ccc",
	"ha": {
		"mode": "ha",
		"replication_mode": "sync"
	},
	"flavor_ref": "rds.mssql.2014.se.s3.xlarge.2.ha",
	"volume": {
		"type": "ULTRAHIGH",
		"size": 40
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.147",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"backup_strategy": {
		"keep_days": 2,
		"start_time": "19:00-20:00"
	},
        "charge_info": {
	       "charge_mode": "prePaid",		
               "period_type": "month",
               "period_num": 1,
               "is_auto_renew": false,
               "is_auto_pay": true
       },
	"password": "Demo@12345678",
	"configuration_id": "52e86e87445847a79bf807ceda213165pr04",
	"enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
	"time_zone": "UTC+04:00",
        "collation": "Cyrillic_General_CI_AS",
	"restore_point": {
		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04",
		"type": "timestamp",
		"restore_time": 1532001446987,
		"database_name": {
			"db1": "dbtest1,dbtest2",
			"db2": "db2,db02",
                        "db3": ""
		}
	}
}

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. This parameter is returned only for the restoration to a new DB instance billed on the pay-per-use basis. Range N/A
order_id	String	Definition Indicates the order ID. This parameter is returned only for the creation of an RDS for SQL Server DB instance billed on the yearly/monthly basis. Range N/A

**Table 12** instance 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 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 information. Range 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. For RDS for SQL Server 2022 Enterprise Edition, 2022 Standard Edition, 2022 Web Edition, 2019 Enterprise Edition, 2019 Standard Edition, 2019 Web Edition, 2017 Enterprise Edition, 2017 Standard Edition, and 2017 Web Edition, the port number can be set to 1433 or 2100 to 9500 (excluding 5050, 5353, 5355, 5985, and 5986). For other editions, the port number can be set to 1433 or 2100 to 9500 (excluding 5355, 5985, and 5986). If this parameter is not set, the default value is as follows: RDS for MySQL: 3306 RDS for PostgreSQL: 5432 RDS for SQL Server: 1433
backup_strategy	Object	Definition Indicates the automated backup policy. For details, see Table 15.
enterprise_project_tag	String	Definition Indicates the project ID. Range N/A
flavor_ref	String	Definition Indicates the specification ID. Range 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 subnet ID. 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.
collation	String	Definition Indicates the collation for RDS for SQL Server. Range N/A
charge_info	Object	Definition Indicates the billing information, which is yearly/monthly or pay-per-use. For details, see Table 9.

**Table 13** datastore field data structure description
Parameter	Mandatory	Type	Description
type	Yes	String	Definition DB engine. Range Its value can be any of the following and is case-insensitive: MySQL PostgreSQL SQLServer
version	Yes	String	Definition Indicates the database version. Range For details about supported database versions, see section Querying Version Information About a DB Engine.
complete_version	No	String	Definition Indicates the complete version number. This parameter is returned only when the DB engine is PostgreSQL. Range N/A

**Table 14** ha field data structure description
Parameter	Mandatory	Type	Description
mode	Yes	String	Definition Primary/standby instance type. Range Ha
replication_mode	Yes	String	Definition Indicates the replication mode for the standby DB instance. Range The value cannot be empty. RDS for MySQL: The value is async or semisync. RDS for PostgreSQL: The value is async or sync. 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	Mandatory	Type	Description
start_time	Yes	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
keep_days	No	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. To extend the retention period, contact customer service. Automated backups can be retained for up to ten years.

**Table 16** volume field data structure description
Parameter	Mandatory	Type	Description
type	Yes	String	Definition Indicates the disk type. Range The value is case-sensitive. ULTRAHIGH: ultra-high I/O storage. CLOUDSSD: cloud SSD storage. This storage type is supported only with general-purpose and dedicated instances. ESSD: extreme SSD storage.
size	Yes	Integer	Definition Indicates the disk size. Range 40–4000, in GB. The value must be a multiple of 10.

Example normal response

RDS for MySQL

{
	"instance": {
		"id": "f5ffdd8b1c98434385eb001904209eacin01",
		"name": "demoname",
		"status": "BUILD",
		"datastore": {
			"type": "MySQL",
			"version": "5.7.31"
		},
		"port": "3306",
		"volume": {
			"type": "CLOUDSSD",
			"size": "40"
		},
		"region": "aaa",
		"backup_strategy": {
			"start_time": "02:00-03:00",
			"keep_days": "7"
		},
		"flavor_ref": "rds.mysql.s1.large",
		"availability_zone": "bbb",
		"vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f",
		"subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7",
		"security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0"
	},
	"job_id": "bf003379-afea-4aa5-aa83-4543542070bc"
}

RDS for PostgreSQL

{
	"instance": {
		"id": "f5ffdd8b1c98434385eb001904209eacin01",
		"name": "demoname",
		"status": "BUILD",
		"datastore": {
			"type": "PostgreSQL",
			"version": "9.6.13"
		},
		"port": "5432",
		"volume": {
			"type": "CLOUDSSD",
			"size": "40"
		},
		"region": "aaa",
		"backup_strategy": {
			"start_time": "02:00-03:00",
			"keep_days": "7"
		},
		"flavor_ref": "rds.pg.s1.large",
		"availability_zone": "bbb",
		"vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f",
		"subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7",
		"security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0"
	},
	"job_id": "bf003379-afea-4aa5-aa83-4543542070bc"
}

RDS for SQL Server

{
	"instance": {
		"id": "f5ffdd8b1c98434385eb001904209eacin01",
		"name": "demoname",
		"status": "BUILD",
		"datastore": {
			"type": "sqlserver",
			"version": "2014_SE"
		},
		"port": "2100",
		"volume": {
			"type": "ULTRAHIGH",
			"size": "40"
		},
		"region": "aaa",
		"backup_strategy": {
			"start_time": "02:00-03:00",
			"keep_days": "7"
		},
		"flavor_ref": "rds.mssql.2014.se.s3.large.2",
		"availability_zone": "bbb",
		"vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f",
		"subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7",
		"security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0",
                "charge_info": {           
                       "charge_mode": "prePaid",            
                       "period_num": 1        
                 },        
                "collation": "Cyrillic_General_CI_AS"
	},
	"order_id": "CS20122919584LQ7K"
}

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.

Restoring Data to a New DB Instance