Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Backup Management/ Restoring Data to the Original Instance or an Existing Instance
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Restoring Data to the Original Instance or an Existing Instance

Function

This API is used to restore data to the original instance or an existing instance. Before calling this API:

Constraints

DB instances will not be displayed unless they have the same DB engine type, version, and table name case sensitivity as the original DB instance.

URI

POST /v3/{project_id}/instances/restore

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

target_instance_id

Yes

String

Target instance ID.

source_instance_id

Yes

String

Source instance ID.

type

Yes

String

Restoration type. Values:

  • backup: indicates restoration from backup files. 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

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

To obtain this value, see Querying Full Backups.

restore_time

No

Long

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Workflow ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

  • Restoring data to the original instance using a backup file 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "backup_id" : "7ffbf305376b4cbea0ae491257b6aaf9br07",
  "type" : "backup"
}
  • Restoring data to the original instance through PITR 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "restore_time" : 1673852043000,
  "type" : "timestamp"
}
  • Restoring data to an existing instance using a backup file 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "backup_id" : "be4ddfd7e2b94640b5e2cb44efb30b22br07",
  "type" : "backup"
}
  • Restoring data to an existing instance through PITR 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "restore_time" : 1673852043000,
  "type" : "timestamp"
}

Example Response

Status code: 200

Success.

{
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management