Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Restoring Tables to a Specified Point in Time
Updated on 2025-09-04 GMT+08:00
View PDF
Share

Restoring Tables to a Specified Point in Time

Function

This API is used to restore tables to a specified point in time. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/backups/restore/tables

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

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

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

restore_time

Yes

String

Definition

Backup time point.

Constraints

The value is a Unix timestamp in milliseconds and represents UTC time. When specifying the parameter, convert the local time from your relevant time zone to a UTC timestamp first. For example, for a time in the Beijing time zone (UTC+08:00), subtract 8 hours to get the UTC timestamp.

Range

To obtain this value, see Querying the Restoration Time Range.

Default Value

N/A

restore_tables

Yes

Array of CreateRestoreDatabaseTableInfo objects

Definition

Database information.

Constraints

N/A

last_table_info

No

String

Definition

Whether data is restored to the most recent table.

Constraints

N/A

Range

  • true: most recent table

  • false: time-specific table

Default Value

false
Table 4 CreateRestoreDatabaseTableInfo

Parameter

Mandatory

Type

Description

database

Yes

String

Definition

Database name.

Constraints

N/A

Range

The database name can contain 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The total number of hyphens (-) cannot exceed 10.

Default Value

false

tables

Yes

Array of CreateRestoreTableInfo objects

Definition

Table information.

Constraints

N/A
Table 5 CreateRestoreTableInfo

Parameter

Mandatory

Type

Description

old_name

Yes

String

Definition

Table name before the restoration.

Constraints

N/A

Range

N/A

Default Value

false

new_name

Yes

String

Definition

Table name after the restoration.

Constraints

N/A

Range

N/A

Default Value

false

Response Parameters

Status code: 200

Table 6 Response body parameter

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Restoring tables to a point in time

POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/backups/restore/tables

{
  "restore_time" : 1690890940000,
  "last_table_info" : true,
  "restore_tables" : [ {
    "database" : "test_db_1",
    "tables" : [ {
      "new_name" : "t3_1690899914000",
      "old_name" : "t3"
    } ]
  } ]
}

Example Response

Status code: 200

Success.

{
  "job_id" : "9c77973c-9332-4fbe-bb4d-b76760dbc9b2"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management