Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Restoring Tables to a Specified Point in Time
Updated on 2026-01-05 GMT+08:00

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:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:instance:tableRestore

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:tableRestore

    -

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

SDK Sample Code

The SDK sample code is as follows.

Restoring tables to a specified point in time

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateRestoreTablesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateRestoreTablesRequest request = new CreateRestoreTablesRequest();
        request.withInstanceId("{instance_id}");
        CreateRestoreTablesRequestBody body = new CreateRestoreTablesRequestBody();
        List<CreateRestoreTableInfo> listRestoreTablesTables = new ArrayList<>();
        listRestoreTablesTables.add(
            new CreateRestoreTableInfo()
                .withOldName("t3")
                .withNewName("t3_1690899914000")
        );
        List<CreateRestoreDatabaseTableInfo> listbodyRestoreTables = new ArrayList<>();
        listbodyRestoreTables.add(
            new CreateRestoreDatabaseTableInfo()
                .withDatabase("test_db_1")
                .withTables(listRestoreTablesTables)
        );
        body.withRestoreTables(listbodyRestoreTables);
        body.withLastTableInfo("true");
        body.withRestoreTime("1690890940000");
        request.withBody(body);
        try {
            CreateRestoreTablesResponse response = client.createRestoreTables(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Restoring tables to a specified point in time

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateRestoreTablesRequest()
        request.instance_id = "{instance_id}"
        listTablesRestoreTables = [
            CreateRestoreTableInfo(
                old_name="t3",
                new_name="t3_1690899914000"
            )
        ]
        listRestoreTablesbody = [
            CreateRestoreDatabaseTableInfo(
                database="test_db_1",
                tables=listTablesRestoreTables
            )
        ]
        request.body = CreateRestoreTablesRequestBody(
            restore_tables=listRestoreTablesbody,
            last_table_info="true",
            restore_time="1690890940000"
        )
        response = client.create_restore_tables(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Restoring tables to a specified point in time

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateRestoreTablesRequest{}
	request.InstanceId = "{instance_id}"
	var listTablesRestoreTables = []model.CreateRestoreTableInfo{
        {
            OldName: "t3",
            NewName: "t3_1690899914000",
        },
    }
	var listRestoreTablesbody = []model.CreateRestoreDatabaseTableInfo{
        {
            Database: "test_db_1",
            Tables: listTablesRestoreTables,
        },
    }
	lastTableInfoCreateRestoreTablesRequestBody:= "true"
	request.Body = &model.CreateRestoreTablesRequestBody{
		RestoreTables: listRestoreTablesbody,
		LastTableInfo: &lastTableInfoCreateRestoreTablesRequestBody,
		RestoreTime: "1690890940000",
	}
	response, err := client.CreateRestoreTables(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.