Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Importing and Verifying HTAP Databases and Tables
Updated on 2025-10-11 GMT+08:00

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:

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

Table 2 Query parameters

Parameter

Mandatory

Type

Description

template_type

Yes

String

Definition

Template type.

Constraints

N/A

Range

import_async: Excel 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

Request Parameters

Table 3 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 4 FormData parameter

Parameter

Mandatory

Type

Description

file

Yes

File

Definition

File to be imported.

Constraints

The file must be in Excel format.

Range

.xlsx file

Default Value

N/A

Response Parameters

Status code: 200

Table 5 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 6 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 7 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 8 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

{
  "file" : "File",
  "is_instance_level" : "false",
  "selected_dbs" : "db1,db2",
  "is_support_regexp" : "false"
}

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

Status Code

Status Code

Description

200

Excel template file imported.

400

Failed to import the Excel template file.

Error Code

For details, see Error Codes.