Updated on 2025-09-19 GMT+08:00

Restoring a Table

Function

This API is used to restore tables.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/snapshots/{snapshot_id}/table-restore

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

snapshot_id

Yes

String

Definition

Snapshot ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

case_sensitive

Yes

Boolean

Definition

Whether the name is case sensitive.

Range

N/A

database

Yes

String

Definition

Database name.

Range

N/A

restore_table_list

Yes

Array of TableDetail objects

Definition

Source table information.

Range

N/A

target_table_list

Yes

Array of TableDetail objects

Definition

Destination table information.

Range

N/A

Table 3 TableDetail

Parameter

Mandatory

Type

Description

schema_name

Yes

String

Definition

Schema name.

Range

N/A

table_name

Yes

String

Definition

Table name.

Range

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

Example Requests

POST https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/snapshots/c719b1a7-c85c-4cb5-a721-7694908c2c11/table-restore

{
  "case_sensitive" : true,
  "database" : "postgres",
  "restore_table_list" : [ {
    "schema_name" : "postgres",
    "table_name" : "public"
  } ],
  "target_table_list" : [ {
    "schema_name" : "postgres",
    "table_name" : "public"
  } ]
}

Example Responses

Status code: 200

The table is successfully restored.

{
  "job_id" : "2c9081c0894918c301894e503ef21b68"
}

Status Codes

Status Code

Description

200

The table is successfully restored.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

500

Internal server error.

503

Service unavailable.