文档首页/ 云数据库 TaurusDB/ API参考/ API(推荐)/ HTAP-标准版/ HTAP库表导入校验 - UploadImportExcelTemplate
更新时间:2025-11-24 GMT+08:00
分享

HTAP库表导入校验 - UploadImportExcelTemplate

功能介绍

创建数据同步时支持Excel导入并进行校验。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:htapInstance:listDatabases

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    • gaussdb:htapInstance:list

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

HTAP标准版实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in17,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 FormData参数

参数

是否必选

参数类型

描述

template_type

String

参数解释

具体选择哪一种模板进行下载。

约束限制

不涉及。

取值范围

import_async: Excel导入文件类型。

默认取值

不涉及。

file

File

参数解释

Excel文件上传。

约束限制

Excel文件。

取值范围

.xlsx文件。

默认取值

不涉及。

is_instance_level

String

参数解释

判断是否是实例级同步。

约束限制

不涉及。

取值范围

  • true:实例级同步。

  • false: 非实例级同步。

默认取值

false。

selected_dbs

String

参数解释

用户选中的数据库名,用英文","隔开。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

is_support_regexp

String

参数解释

是否支持标配符。

约束限制

不涉及。

取值范围

  • true: 支持标配符。

  • false: 不支持标配符。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

success

Boolean

参数解释

Excel导入返回状态。

取值范围

  • true: 导入成功。

  • false: 导入失败。

processed_rows

Integer

参数解释

已处理的行数。

取值范围

不涉及。

error_tables

Array of ErrorTable objects

参数解释

导入失败返回的错误列表。

success_tables

Array of SuccessTable objects

参数解释

Excel导入验证成功的列表。

error_count

Integer

参数解释

Excel导入验证失败的行数。

取值范围

不涉及。

success_count

Integer

参数解释

Excel导入验证成功的行数。

取值范围

不涉及。

表5 ErrorTable

参数

参数类型

描述

message

String

参数解释

Excel导入失败的对象信息。

取值范围

不涉及。

database_name

String

参数解释

Excel导入失败的数据库名。

取值范围

不涉及。

table_name

String

参数解释

Excel导入失败的表名。

取值范围

不涉及。

row_number

Integer

参数解释

Excel导入失败的行。

取值范围

不涉及。

full_description

String

参数解释

Excel导入失败的错误信息描述。

取值范围

不涉及。

表6 SuccessTable

参数

参数类型

描述

db_name

String

参数解释

Excel导入成功的数据库名。

取值范围

不涉及。

table_name

String

参数解释

Excel导入成功的表名。

取值范围

不涉及。

config_name

String

参数解释

Excel导入成功的表配置。

取值范围

不涉及。

row_number

Integer

参数解释

Excel导入成功的行数。

取值范围

不涉及。

full_table_name

String

参数解释

Excel导入成功的表全名。

取值范围

不涉及。

valid

Boolean

参数解释

Excel信息是否合规。

取值范围

  • true:校验结果合规。

  • false:校验结果不合规。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

HTAP库表导入校验。

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

响应示例

状态码:200

Excel Template文件上传导入成功

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

状态码:400

Excel Template文件导入失败

  • 示例 1

    null
  • 示例 2

    false
  • 示例 3

    10
  • 示例 4

    [ {
      "message" : "数据库未在选择范围内",
      "database_name" : "testdb2",
      "table_name" : "persons2",
      "row_number" : 4,
      "full_description" : "库名:testdb2,表名:persons2,错误信息:数据库未在选择范围内"
    }, {
      "message" : "数据库未在选择范围内",
      "database_name" : "testdb3",
      "table_name" : "persons3",
      "row_number" : 5,
      "full_description" : "库名:testdb3,表名:persons3,错误信息:数据库未在选择范围内"
    }, {
      "message" : "数据库未在选择范围内",
      "database_name" : "testdb4",
      "table_name" : "persons4",
      "row_number" : 6,
      "full_description" : "库名:testdb4,表名:persons4,错误信息:数据库未在选择范围内"
    }, {
      "message" : "数据库未在选择范围内",
      "database_name" : "testdb5",
      "table_name" : "persons5",
      "row_number" : 7,
      "full_description" : "库名:testdb5,表名:persons5,错误信息:数据库未在选择范围内"
    }, {
      "message" : "数据库未在选择范围内",
      "database_name" : "testdb6",
      "table_name" : "persons6",
      "row_number" : 8,
      "full_description" : "库名:testdb6,表名:persons6,错误信息:数据库未在选择范围内"
    }, {
      "message" : "数据库未在选择范围内",
      "database_name" : "testdb7",
      "table_name" : "persons7",
      "row_number" : 9,
      "full_description" : "库名:testdb7,表名:persons7,错误信息:数据库未在选择范围内"
    }, {
      "message" : "数据库未在选择范围内",
      "database_name" : "testdb8",
      "table_name" : "persons8",
      "row_number" : 10,
      "full_description" : "库名:testdb8,表名:persons8,错误信息:数据库未在选择范围内"
    }, {
      "message" : "数据库未在选择范围内",
      "database_name" : "testdb9",
      "table_name" : "persons9",
      "row_number" : 11,
      "full_description" : "库名:testdb9,表名:persons9,错误信息:数据库未在选择范围内"
    }, {
      "message" : "数据库未在选择范围内",
      "database_name" : "testdb10",
      "table_name" : "persons10",
      "row_number" : 12,
      "full_description" : "库名:testdb10,表名:persons10,错误信息:数据库未在选择范围内"
    } ]
  • 示例 5

    [ {
      "db_name" : "testdb1",
      "table_name" : "persons1",
      "config_name" : "",
      "row_number" : 3,
      "full_table_name" : "testdb1.persons1",
      "valid" : true
    } ]
  • 示例 6

    9
  • 示例 7

    1

SDK代码示例

SDK代码示例如下。

 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
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());
        }
    }
}
 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
# 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)
 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
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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Excel Template文件上传导入成功

400

Excel Template文件导入失败

错误码

请参见错误码

相关文档