• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v3 (Recommended)
  5. Backup and Restoration
  6. Restoring Data to a New DB Instance

Restoring Data to a New DB Instance

Function

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

URI

  • URI format

    PATH: /{version_id}/{project_id}/instances

    Method: POST

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    version_id

    Yes

    Specifies the API version. It is case-sensitive and the value is v3.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

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.

    The value must be 4 to 64 characters in length and start with a letter. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_).

    ha

    No

    Dictionary data structure

    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 group ID.

    port

    No

    String

    Specifies the database port information.

    • The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system and cannot be used).
    • The PostgreSQL database port ranges from 2100 to 9500.
    • The Microsoft SQL Server database port can be 1433 or ranges from 2100 to 9500, excluding 5355 and 5985.

    If this parameter is not set, the default value is as follows:

    • For MySQL, the default value is 3306.
    • For PostgreSQL, the default value is 5432.
    • For Microsoft SQL Server, the default value is 1433.

    password

    Yes

    String

    Specifies the database password.

    Value range:

    The value cannot be empty and should contain 8 to 32 characters, including uppercase and lowercase letters, digits, and the following special characters: ~!@#%^*-_=+?

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

    backup_strategy

    No

    Dictionary data structure

    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.

    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

    Dictionary data structure

    Specifies the volume information.

    For details, see Table 5.

    availability_zone

    Yes

    String

    Indicates the AZ ID.

    The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.

    vpc_id

    No

    String

    Specifies the VPC ID. For details about how to obtain this parameter value, see section "Virtual Private Cloud" in the Virtual Private Cloud API Reference.

    Valid value: The value cannot be empty. The string length and whether the string complying with UUID regular expression rules are verified.

    subnet_id

    No

    String

    Specifies the subnet information. For details about how to obtain this parameter value, see section "Subnet" in the Virtual Private Cloud API Reference.

    security_group_id

    No

    String

    Specifies the security group which the RDS DB instance belongs to. For details about how to obtain this parameter value, see section "Security Group" in the Virtual Private Cloud API Reference.

    restore_point

    Yes

    Dictionary data structure

    Specifies the restoration information.

    For details, see Table 6.

    Table 3 ha field data structure description

    Name

    Mandatory

    Type

    Description

    mode

    Yes

    String

    Specifies the DB instance type. The value is Ha (primary/standby DB instances) and is case-insensitive.

    replication_mode

    Yes

    String

    Specifies the replication mode for the standby DB instance.

    The value cannot be empty.

    • For MySQL, the value is async or semisync.
    • For PostgreSQL, the value is async or sync.
    • For Microsoft 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 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

    Int

    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:

    • COMMON: indicates the SATA type.
    •  
    • ULTRAHIGH: indicates the SSD type.

    size

    Yes

    Int

    Specifies the volume size.

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

    NOTICE:

    The volume size of the new DB instance must be greater than or 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 using backup files for restoration. In this mode, type is not mandatory and backup_id is mandatory.
    • timestamp: indicates the point-in-time restoration mode. In this mode, type is mandatory and restore_time is no 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.

    restore_time

    No

    Int

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

  • Request example

    Use backup files for restoration:

    {
    	"name": "targetInst",
    	"availability_zone": "eu-de-01,eu-de-02",
    	"ha": {
    		"mode": "ha",
    		"replication_mode": "async"
    	},
    	"flavor_ref": "rds.mysql.s1.large",
    	"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",
    	"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",
    	"restore_point": {
    		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
    		"type": "backup",
    		"backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe"
    	}
    }

    Use PITR for restoration:

    {
    	"name": "targetInst",
    	"availability_zone": "eu-de-01,eu-de-02",
    	"ha": {
    		"mode": "ha",
    		"replication_mode": "async"
    	},
    	"flavor_ref": "rds.mysql.s1.large",
    	"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",
    	"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",
    	"restore_point": {
    		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
    		"type": "timestamp",
    		"restore_time": 1532001446987
    	}
    }

Normal Response

  • Parameter description
    Table 7 Parameter description

    Name

    Type

    Description

    instance

    Dictionary data structure

    Indicates the DB instance information.

    For details, see Table 8.

    job_id

    String

    Indicates the ID of the DB instance creation task.

    Table 8 instance description

    Name

    Type

    Description

    id

    String

    Indicates the DB instance ID.

    name

    String

    Indicates the DB instance name. The name of the DB instance of the same type must be unique for the same tenant.

    The value must be 4 to 64 characters in length and start with a letter. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_).

    status

    String

    Indicates the DB instance status. For example, BUILD indicates that the DB instance is being created.

    datastore

    Dictionary data structure

    Indicates the database information.

    For details, see Table 9.

    ha

    Dictionary data structure

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

    For details, see Table 10.

    configuration_id

    String

    Specifies the parameter group ID.

    port

    String

    Indicates the database port information.

    • The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system and cannot be used).
    • The PostgreSQL database port ranges from 2100 to 9500.
    • The Microsoft SQL Server database port can be 1433 or ranges from 2100 to 9500, excluding 5355 and 5985.

    If this parameter is not set, the default value is as follows:

    • For MySQL, the default value is 3306.
    • For PostgreSQL, the default value is 5432.
    • For Microsoft SQL Server, the default value is 1433.

    password

    String

    Indicates the database password.

    backup_strategy

    Dictionary data structure

    Indicates the automated backup policy.

    For details, see Table 11.

    disk_encryption_id

    String

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

    flavor_ref

    String

    Indicates the specification ID.

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

    volume

    Dictionary data structure

    Indicates the volume information.

    For details, see Table 12.

    region

    String

    Indicates the region ID.

    The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.

    availability_zone

    String

    Indicates the AZ ID.

    The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.

    vpc_id

    String

    Indicates the VPC ID. For details about how to obtain this parameter value, see section "Virtual Private Cloud" in the Virtual Private Cloud API Reference.

    Valid value: The value cannot be empty. The string length and whether the string complying with UUID regular expression rules are verified.

    subnet_id

    String

    Indicates the subnet information. For details about how to obtain this parameter value, see section "Subnet" in the Virtual Private Cloud API Reference.

    security_group_id

    String

    Indicates the security group which the RDS DB instance belongs to.

    For details about how to obtain this parameter value, see section "Security Group" 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
    • SQLServer

    version

    Yes

    String

    Indicates the database version.

    For details about supported database versions, see section Database Version Queries.

    Table 10 ha field data structure description

    Name

    Mandatory

    Type

    Description

    mode

    Yes

    String

    Indicates the DB instance type. The value is Ha (primary/standby DB instances).

    replication_mode

    Yes

    String

    Indicates the replication mode for the standby DB instance.

    The value cannot be empty.

    • For MySQL, the value is async or semisync.
    • For PostgreSQL, the value is async or sync.
    • For Microsoft 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 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

    Int

    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:

    • COMMON: indicates the SATA type.
    •  
    • ULTRAHIGH: indicates the SSD type.

    size

    Yes

    Int

    Indicates the volume size.

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

  • Response example
    {
    	"instance": {
    		"id": "f5ffdd8b1c98434385eb001904209eacin01",
    		"name": "ytf-test",
    		"status": "BUILD",
    		"datastore": {
    			"type": "MySQL",
    			"version": "5.6.41"
    		},
    		"port": "3306",
    		"volume": {
    			"type": "ULTRAHIGH",
    			"size": "40"
    		},
    		"region": "eu-de",
    		"backup_strategy": {
    			"start_time": "02:00-03:00",
    			"keep_days": "7"
    		},
    		"flavor_ref": "rds.mysql.s1.large",
    		"availability_zone": "eu-de-01",
    		"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.