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

Restoring Data to a New DB Instance

Function

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

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

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.
  • The total volume 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 Parameter description

    Name

    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

Parameter description
Table 2 Parameter description

Name

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 (_).

password

Yes

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.

You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking.

flavor_ref

Yes

String

Specifies the specification code. The value cannot be empty.

For details, see spec_code in section Querying Database Specifications.

volume

Yes

Object

Specifies the volume information.

For details, see Table 5.

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.

restore_point

Yes

Object

Specifies the restoration information.

For details, see Table 6.

ha

No

Object

Specifies the HA configuration parameters, which are used when creating primary/standby DB instances.

For details, see Table 3.

configuration_id

No

String

Specifies the parameter template ID.

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

backup_strategy

No

Object

Specifies the advanced backup policy.

For details, see Table 4.

disk_encryption_id

No

String

Specifies the key ID for disk encryption. The default value is empty.

vpc_id

No

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

No

String

Specifies the subnet 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.

data_vip

No

String

Specifies the floating IP address of a DB instance. To obtain this parameter value, use either of the following methods:

  • Method 1: Log in to VPC console and click the target subnet on the Subnets page. You can view the subnet CIDR block on the displayed page.
  • Method 2: See the "Querying Subnets" section in the Virtual Private Cloud API Reference.

security_group_id

No

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.
Table 3 ha field data structure description

Name

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.

The value cannot be empty.

  • RDS for MySQL: The value is async or semisync.
  • 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 4 backup_strategy field data structure description

Name

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 5 volume field data structure description

Name

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 type.

size

Yes

Integer

Specifies the volume size.

Its value range is from 40 GB to 4,000 GB. The value must be a multiple of 10.

NOTICE:

The volume size of the new DB instance must be at least equal to that of the original DB instance.

Table 6 restore_point field data structure description

Name

Mandatory

Type

Description

instance_id

Yes

String

Specifies the DB instance ID.

type

Yes

String

Specifies the restoration mode. Enumerated values include:

  • 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.

backup_id

No

String

Specifies the ID of the backup used to restore data. This parameter must be specified when the backup file is used for restoration.

NOTICE:

When type is not mandatory, backup_id is mandatory.

restore_time

No

Integer

Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC.

NOTICE:

When type is mandatory, restore_time is mandatory.

Example Request

  • Restoring an RDS for MySQL backup to a new DB instance
    {
    	"name": "targetInst",
    	"availability_zone": "bbb,ccc",
    	"ha": {
    		"mode": "ha",
    		"replication_mode": "async"
    	},
    	"flavor_ref": "rds.mysql.s1.large",
    	"volume": {
    		"type": "ULTRAHIGH",
    		"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",
    	"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",
    	"time_zone": "UTC+04:00",
    	"restore_point": {
    		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
    		"type": "backup",
    		"backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe"
    	}
    }
  • Restoring data of an RDS for MySQL DB instance to a specific point in time

Response

  • Normal response
    Table 7 Parameter description

    Name

    Type

    Description

    instance

    Object

    Indicates the DB instance information.

    For details, see Table 8.

    job_id

    String

    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.

    Table 8 instance description

    Name

    Type

    Description

    id

    String

    Indicates the DB instance ID.

    name

    String

    Indicates the DB instance name.

    The DB instance name of the same type must be unique for 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 9.

    ha

    Object

    Indicates the HA configuration parameters. This parameter is returned only when primary/standby DB instances are created.

    For details, see Table 10.

    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 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

    backup_strategy

    Object

    Indicates the automated backup policy.

    For details, see Table 11.

    flavor_ref

    String

    Indicates the specification ID.

    For details, see spec_code in Table 3 in section Querying Database Specifications.

    volume

    Object

    Indicates the volume information.

    For details, see Table 12.

    region

    String

    Indicates the region ID.

    availability_zone

    String

    Indicates the AZ ID.

    vpc_id

    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

    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

    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.
    Table 9 datastore field data structure description

    Name

    Mandatory

    Type

    Description

    type

    Yes

    String

    Indicates the DB engine. Its value can be any of the following and is case-insensitive:

    • MySQL
    • PostgreSQL

    version

    Yes

    String

    Indicates the database version.

    For details about supported database versions, see section Querying Version Information About a DB Engine.

    Table 10 ha field data structure description

    Name

    Mandatory

    Type

    Description

    mode

    Yes

    String

    Indicates the primary/standby instance type. The value is Ha.

    replication_mode

    Yes

    String

    Indicates the replication mode for the standby DB instance.

    The value cannot be empty.

    • RDS for MySQL: The value is async or semisync.
    • 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 11 backupStrategy field data structure description

    Name

    Mandatory

    Type

    Description

    start_time

    Yes

    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

    keep_days

    No

    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.

    Table 12 volume field data structure description

    Name

    Mandatory

    Type

    Description

    type

    Yes

    String

    Indicates the volume type.

    Its value can be any of the following and is case-sensitive:

    • ULTRAHIGH: ultra-high I/O type.

    size

    Yes

    Integer

    Indicates the volume size.

    Its value range is from 40 GB to 4,000 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": "ULTRAHIGH",
    			"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": "ULTRAHIGH",
    			"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"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.