Importing and Verifying HTAP Databases and Tables

Function

This API is used to import and verify an Excel file for data synchronization. Before calling this API:

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

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:htapInstance:listDatabases	List	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:htapInstance:list	-

URI

POST /v3/{project_id}/instances/{instance_id}/htap/template

**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 Standard HTAP instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in17. 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** FormData parameters
Parameter	Mandatory	Type	Description
template_type	Yes	String	Definition Template type. Constraints N/A Range import_async: Excel file Default Value N/A
file	Yes	File	Definition File to be imported. Constraints The file must be in Excel format. Range .xlsx file Default Value N/A
is_instance_level	No	String	Definition Whether the synchronization is at the instance level. Constraints N/A Range true: The synchronization is at the instance level. false: The synchronization is not at the instance level. Default Value false
selected_dbs	Yes	String	Definition Names of the selected databases, which are separated by commas (,). Constraints N/A Range N/A Default Value N/A
is_support_regexp	No	String	Definition Whether regular expressions are supported. Constraints N/A Range true: Regular expressions are supported. false: Regular expressions are not supported. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
success	Boolean	Definition Whether the Excel file is successfully imported. Range true: The Excel file is successfully imported. false: The Excel file failed to be imported.
processed_rows	Integer	Definition Number of processed rows. Range N/A
error_tables	Array of ErrorTable objects	Definition List of tables that failed to be imported.
success_tables	Array of SuccessTable objects	Definition List of tables that are successfully imported from the Excel file.
error_count	Integer	Definition Number of rows that failed to be imported from the Excel file. Range N/A
success_count	Integer	Definition Number of rows that are successfully imported from the Excel file. Range N/A

**Table 5** ErrorTable
Parameter	Type	Description
message	String	Definition Information about objects that failed to be imported from the Excel file. Range N/A
database_name	String	Definition Name of the database that failed to be imported from the Excel file. Range N/A
table_name	String	Definition Name of the table that failed to be imported from the Excel file. Range N/A
row_number	Integer	Definition Number of the row that failed to be imported from the Excel file. Range N/A
full_description	String	Definition Error message displayed when the Excel file failed to be imported. Range N/A

**Table 6** SuccessTable
Parameter	Type	Description
db_name	String	Definition Name of the database that is successfully imported from the Excel file. Range N/A
table_name	String	Definition Name of the table that is successfully imported from the Excel file. Range N/A
config_name	String	Definition Configuration of the table that is successfully imported from the Excel file. Range N/A
row_number	Integer	Definition Number of the row that is successfully imported from the Excel file. Range N/A
full_table_name	String	Definition Full name of the table that is successfully imported from the Excel file. Range N/A
valid	Boolean	Definition Whether information in the Excel file is valid. Range true: The information is valid. false: The information is invalid.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/f6df5f5cd3bf447baa8fb0373f8e5992in07/htap/template

Example Response

Status code: 200

Excel template file imported.

{
  "success" : true,
  "processed_rows" : 6,
  "error_tables" : [ ],
  "success_tables" : [ {
    "db_name" : "db1",
    "table_name" : "group_mapping_rules",
    "config_name" : "",
    "row_number" : 3,
    "full_table_name" : "db1.group_mapping_rules",
    "valid" : true
  }, {
    "db_name" : "db1",
    "table_name" : "plan_directives",
    "config_name" : "",
    "row_number" : 4,
    "full_table_name" : "db1.plan_directives",
    "valid" : true
  }, {
    "db_name" : "db1",
    "table_name" : "resource_plans",
    "config_name" : "",
    "row_number" : 5,
    "full_table_name" : "db1.resource_plans",
    "valid" : true
  }, {
    "db_name" : "db1",
    "table_name" : "tenant",
    "config_name" : "",
    "row_number" : 6,
    "full_table_name" : "db1.tenant",
    "valid" : true
  }, {
    "db_name" : "db1",
    "table_name" : "tenant_db",
    "config_name" : "",
    "row_number" : 7,
    "full_table_name" : "db1.tenant_db",
    "valid" : true
  }, {
    "db_name" : "db1",
    "table_name" : "tenant_resource_configs",
    "config_name" : "",
    "row_number" : 8,
    "full_table_name" : "db1.tenant_resource_configs",
    "valid" : true
  } ],
  "error_count" : 0,
  "success_count" : 6
}

Status code: 400

Failed to import the Excel template file.

[ {
  "message" : "The database is not within the selected range.",
  "database_name" : "testdb2",
  "table_name" : "persons2",
  "row_number" : 4,
  "full_description" : "database name: testdb2, table name: persons2, error message: The database is not within the selected range."
}, {
  "message" : "The database is not within the selected range.",
  "database_name" : "testdb3",
  "table_name" : "persons3",
  "row_number" : 5,
  "full_description" : "database name: testdb3, table name: persons3, error message: The database is not within the selected range."
}, {
  "message" : "The database is not within the selected range.",
  "database_name" : "testdb4",
  "table_name" : "persons4",
  "row_number" : 6,
  "full_description" : "database name: testdb4, table name: persons4, error message: The database is not within the selected range."
}, {
  "message" : "The database is not within the selected range.",
  "database_name" : "testdb5",
  "table_name" : "persons5",
  "row_number" : 7,
  "full_description" : "database name: testdb5, table name: persons5, error message: The database is not within the selected range."
}, {
  "message" : "The database is not within the selected range.",
  "database_name" : "testdb6",
  "table_name" : "persons6",
  "row_number" : 8,
  "full_description" : "database name: testdb6, table name: persons6, error message: The database is not within the selected range."
}, {
  "message" : "The database is not within the selected range.",
  "database_name" : "testdb7",
  "table_name" : "persons7",
  "row_number" : 9,
  "full_description" : "database name: testdb7, table name: persons7, error message: The database is not within the selected range."
}, {
  "message" : "The database is not within the selected range.",
  "database_name" : "testdb8",
  "table_name" : "persons8",
  "row_number" : 10,
  "full_description" : "database name: testdb8, table name: persons8, error message: The database is not within the selected range."
}, {
  "message" : "The database is not within the selected range.",
  "database_name" : "testdb9",
  "table_name" : "persons9",
  "row_number" : 11,
  "full_description" : "database name: testdb9, table name: persons9, error message: The database is not within the selected range."
}, {
  "message" : "The database is not within the selected range.",
  "database_name" : "testdb10",
  "table_name" : "persons10",
  "row_number" : 12,
  "full_description" : "database name: testdb10, table name: persons10, error message: The database is not within the selected range."
} ]

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           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.*;


public class UploadImportExcelTemplateSolution {

    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();
        UploadImportExcelTemplateRequest request = new UploadImportExcelTemplateRequest();
        request.withInstanceId("{instance_id}");
        try {
            UploadImportExcelTemplateResponse response = client.uploadImportExcelTemplate(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = UploadImportExcelTemplateRequest()
        request.instance_id = "{instance_id}"
        response = client.upload_import_excel_template(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           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.UploadImportExcelTemplateRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.UploadImportExcelTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     