Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Querying Tables for Table-level Point-in-Time Recovery

Updated on 2024-09-11 GMT+08:00

View PDF

Querying Tables for Table-level Point-in-Time Recovery

Function

This API is used to query available tables for table-level point-in-time recovery (PITR). Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**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.
instance_id	Yes	String	Instance ID, which is compliant with the UUID format.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
restore_time	Yes	String	Backup time, in timestamp format. To obtain this value, see Querying the Restoration Time Range.
last_table_info	Yes	String	Whether data is restored to the most recent table. true: most recent table false: time-specific table
database_name	No	String	Database name, which is used for fuzzy match.
table_name	No	String	Table name, which is used for fuzzy match.

Request Parameters

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_databases	Integer	Total number of databases.
databases	Array of RestoreDatabaseInfos objects	Database information.

**Table 5** RestoreDatabaseInfos
Parameter	Type	Description
name	String	Database name.
total_tables	Integer	Total number of tables.
tables	Array of RestoreDatabaseTableInfo objects	Table information.

**Table 6** RestoreDatabaseTableInfo
Parameter	Type	Description
name	String	Table name.

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 tables for table-level point-in-time recovery

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"
    } ]
  } ]
}