Help Center/ GaussDB(DWS)/ API Reference/ API Description/ Snapshot Management/ Checking the Name of the Table to Be Restored
Updated on 2024-04-18 GMT+08:00

Checking the Name of the Table to Be Restored

Function

This API is used to check the name of the table to be restored.

Call Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/snapshots/{snapshot_id}/table-restore-check
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

snapshot_id

Yes

String

Snapshot ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

case_sensitive

Yes

Boolean

Indicates whether the name is case sensitive.

database

Yes

String

Database name

restore_table_list

Yes

Array of TableDetail objects

Source table information

target_table_list

Yes

Array of TableDetail objects

Destination table information

Table 3 TableDetail

Parameter

Mandatory

Type

Description

schema_name

Yes

String

Schema name

table_name

Yes

String

Table name

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

check_table_name_result

CheckTableNameResult object

Check results.

Table 5 CheckTableNameResult

Parameter

Type

Description

database

String

Database name

restore_table_list

Array of strings

Information about the source table in a restoration.

target_table_list

Array of strings

Information about the destination table in a restoration.

Example Request

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

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

Example Response

Status code: 200

Succeeded in checking the name of the table to be restored.

{
  "check_table_name_result" : {
    "database" : "postgres",
    "restore_table_list" : null,
    "target_table_list" : null
  }
}

SDK Sample Code

The sample code is as follows:

 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
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.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;

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

public class CheckTableRestoreSolution {

    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");

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        CheckTableRestoreRequest request = new CheckTableRestoreRequest();
        CheckTableRestoreRequestBody body = new CheckTableRestoreRequestBody();
        List<TableDetail> listbodyTargetTableList = new ArrayList<>();
        listbodyTargetTableList.add(
            new TableDetail()
                .withSchemaName("postgres")
                .withTableName("public")
        );
        List<TableDetail> listbodyRestoreTableList = new ArrayList<>();
        listbodyRestoreTableList.add(
            new TableDetail()
                .withSchemaName("postgres")
                .withTableName("public")
        );
        body.withTargetTableList(listbodyTargetTableList);
        body.withRestoreTableList(listbodyRestoreTableList);
        body.withDatabase("postgres");
        body.withCaseSensitive(true);
        request.withBody(body);
        try {
            CheckTableRestoreResponse response = client.checkTableRestore(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());
        }
    }
}
 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = CheckTableRestoreRequest()
        listTargetTableListbody = [
            TableDetail(
                schema_name="postgres",
                table_name="public"
            )
        ]
        listRestoreTableListbody = [
            TableDetail(
                schema_name="postgres",
                table_name="public"
            )
        ]
        request.body = CheckTableRestoreRequestBody(
            target_table_list=listTargetTableListbody,
            restore_table_list=listRestoreTableListbody,
            database="postgres",
            case_sensitive=True
        )
        response = client.check_table_restore(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/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")

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

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.CheckTableRestoreRequest{}
	var listTargetTableListbody = []model.TableDetail{
        {
            SchemaName: "postgres",
            TableName: "public",
        },
    }
	var listRestoreTableListbody = []model.TableDetail{
        {
            SchemaName: "postgres",
            TableName: "public",
        },
    }
	request.Body = &model.CheckTableRestoreRequestBody{
		TargetTableList: listTargetTableListbody,
		RestoreTableList: listRestoreTableListbody,
		Database: "postgres",
		CaseSensitive: true,
	}
	response, err := client.CheckTableRestore(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

Succeeded in checking the name of the table to be restored.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

500

Internal server error.

503

Service unavailable.