Help Center/ TaurusDB/ API Reference/ Historical APIs/ Backup Management/ Querying Available Tables for Table-level PITR
Updated on 2025-07-31 GMT+08:00
View PDF
Share

Querying Available Tables for Table-level PITR

Function

This API is used to query available tables for table-level PITR. Before calling this API:

This historical API may not be maintained in the future. You are advised to switch workloads to the new API (Querying Available Tables for Table-level PITR).

URI

GET /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
Table 2 Query 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

last_table_info

Yes

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

N/A

database_name

No

String

Definition

Database name, which is used for fuzzy match.

Constraints

N/A

Range

N/A

Default Value

N/A

table_name

No

String

Definition

Table name, which is used for fuzzy match.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_databases

Integer

Definition

Total number of tables in an instance.

Range

N/A

databases

Array of RestoreDatabaseInfos objects

Definition

Database information.
Table 5 RestoreDatabaseInfos

Parameter

Type

Description

name

String

Definition

Database name.

Range

N/A

total_tables

Integer

Definition

Total number of tables.

Range

N/A

tables

Array of RestoreDatabaseTableInfo objects

Definition

Table information.
Table 6 RestoreDatabaseTableInfo

Parameter

Type

Description

name

String

Definition

Table name.

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

Querying available tables for table-level PITR

GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/backups/restore/tables?database_name=test&last_table_info=true&restore_time=1690890940000&table_name=t

Example Response

Status code: 200

Success.

{
  "total_databases" : 1,
  "databases" : [ {
    "name" : "test_db_1",
    "total_tables" : 1,
    "tables" : [ {
      "name" : "t3"
    } ]
  } ]
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.

Parent topic: Backup Management