Querying Available Tables for Table-level PITR
Function
This API is used to query available tables for table-level PITR. Before calling this API:
- Learn how to authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3.1/{project_id}/instances/{instance_id}/backups/restore/tables
| 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 |
| 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. 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 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
| 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 Default Value en-us |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total_tables | Integer | Definition Total number of tables in an instance. Range N/A |
| databases | Array of RestoreDatabaseInfos objects | Definition Database information. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition Database name. 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. |
| total_tables | Integer | Definition Total number of tables. Range N/A |
| tables | Array of RestoreDatabaseTableInfo objects | Definition Table information. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Definition Table name. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 500
| 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.1/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_tables" : 1,
"databases" : [ {
"name" : "test_db_1",
"total_tables" : 1,
"tables" : [ {
"name" : "t3"
} ]
} ]
} Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.