Restoring Data to a New DB Instance

Function

This API is used to restore data to a new DB instance using backups. Before calling this API:

Constraints

The DB engine versions and instance types of the original and new instances must be the same.

The specifications of the new instance must be greater than or equal to those of the original instance.

URI

Request

Table 2 Parameter description

Parameter

Mandatory

Type

Description

name

Yes

String

DB instance name.

Instances of the same type can have same names under the same tenant.

The name must consist of 4 to 64 characters and start with a letter. It can contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).

availability_zone

Yes

String

AZ ID.

The value cannot be left blank. You can deploy GaussDB in the same AZ or across three different AZs, and use commas (,) to separate AZs. For example:

  • To deploy a DB instance in the same AZ, enter three same AZ IDs.
  • To deploy a DB instance across three different AZs, enter three different AZ IDs.

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

flavor_ref

Yes

String

Specification code. The value cannot be empty. For details on how to obtain the GaussDB specification code, see DB Instance Specifications.

volume

Yes

Object

Volume information.

For details, see Table 3.

vpc_id

Yes

String

VPC ID. To obtain this parameter value, use the following methods:

  • Method 1: Log in to VPC console and view the VPC ID in the VPC details.
  • Method 2: See the section "Querying VPCs" in the Virtual Private Cloud API Reference.

subnet_id

Yes

String

Network ID. 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 network ID on the displayed page.
  • Method 2: See the section "Querying Subnets" in the Virtual Private Cloud API Reference.
  • Method 2: See section "Querying Subnets" under "APIs" or "Querying Networks" under "OpenStack Neutron APIs" in Virtual Private Cloud API Reference.

security_group_id

Yes

String

Security group which the instance is associated with. 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 section "Querying Security Groups" in the Virtual Private Cloud API Reference.

password

Yes

String

Database password.

The password must:

Consist of 8 to 32 characters and include at least three of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#%^*-_=+?,).

Enter a strong password to improve security, preventing security risks such as brute force cracking.

charge_info

No

Object

Billing mode, which can be pay-per-use.

For details, see Table 4.

backup_strategy

No

Object

Automated backup policy.

restore_point

Yes

Object

Restoration information.

For details, see Table 5.

configuration_id

No

String

Parameter template ID. If this parameter is not specified, the default parameter template is used.

port

No

String

Port number used by the database to provide services for external systems, ranging from 1024 to 39998. It cannot be set to the default value 8000. The following ports are not allowed: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 12016, 12017, 20049, 20050, 21731, 21732, 32122, 32123, and 32124.

time_zone

No

String

UTC time zone.

  • If this parameter is not specified, GaussDB uses UTC by default.
  • If this parameter is specified, the value ranges from UTC-12:00 to UTC+12:00 at the full hour. For example, the parameter can be UTC+08:00 rather than UTC+08:30.

enable_force_switch

No

Boolean

Whether to forcibly promote a standby node to primary. The value can only be true or false.

true: The function is enabled. false: (default value) The function is disabled. Only 1.2.2 and later versions are supported.

NOTE:

The function is suitable for the following scenario: When the primary node is faulty, a standby node is forcibly promoted to primary to provide services, ensuring the instance availability. When the instance is faulty, this function is used to recover services as soon as possible at the cost of partial data loss. You are not advised to use this function if you are not clear about the impact of data loss on services.
Table 3 volume field data structure description

Parameter

Mandatory

Type

Description

type

Yes

String

Disk type.

Only ULTRAHIGH is supported, which indicates the local disk.

size

Yes

Integer

Storage space, which must be at least that of the original DB instance. For example, if this parameter is set to 40, 40 GB of storage is allocated to the instance.

ECS deployment: The value must be a multiple of (Number of shards x 40 GB), ranging from (Number of shards x 40 GB) to (Number of shards x 16 TB).
Table 4 charge_info field data structure description

Parameter

Mandatory

Type

Description

charge_mode

Yes

String

Billing mode. postPaid: pay-per-use billing.

Table 5 restore_point field data structure description

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Source instance ID.

backup_id

No

String

ID of the backup to be restored.

type

No

String

Restoration type. Value:

  • backup: indicates data is restored using backups. In this mode, type is optional and backup_id is mandatory.
  • timestamp: indicates data is restored using point-in-time recovery (PITR). In this mode, type and restore_time are both mandatory.

Value:

  • backup
  • timestamp

restore_time

No

Long

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

Example Request

Restoring instance data

Response

{
    "instance": {
        "id": "2gfdsh844a4023a776fc5c5fb71fb4in14",
        "name": "gaussdb-instance-rep2",
        "status": "BUILD",
        "datastore": {
            "type": "GaussDB",
            "version": "1.4"
        },
        "ha": {
            "mode": "enterprise",
            "consistency": "strong",
            "replication_mode": "sync"
        },
        "volume": {
            "type": "ULTRAHIGH",
            
            "size": 160
        },
        "port": "8000",
        "replica_num": 3,
        "region": "regionA",
        "enable_parallel_restore": false,
        
        "availability_zone": "aaa,bbb,ccc",
        "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
        "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
        "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
        "charge_info": {
            "charge_mode": "postPaid"
        },
        
    },
    "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Backup Management