文档首页/ 云数据库 TaurusDB/ API参考/ API/ HTAP-标准版/ HTAP数据同步表配置校验- CheckTableConfig
更新时间:2026-09-14 GMT+08:00

HTAP数据同步表配置校验 - CheckTableConfig

功能介绍

HTAP数据同步表配置校验。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:htapInstance:tablesConfigCheck

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:htapInstance:list

    -

URI

POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/table-config-check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

租户在某一Region下的project ID。

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

instance_id

是

String

参数解释:

StarRocks实例ID,严格匹配UUID规则。

获取方法请参见查询HTAP实例列表。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,后缀为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 请求Body参数

参数

是否必选

参数类型

描述

source_instance_id

否

String

参数解释:

TaurusDB实例ID。

获取方法请参见查询实例列表。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

source_node_id

否

String

参数解释:

TaurusDB只读节点ID。

获取方法请参见查询实例详情信息。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

source_database_name

否

String

参数解释:

TaurusDB数据库名。

获取方法请参见查询数据库列表。

约束限制:

不涉及。

取值范围:

字符长度限制3~1024位,仅支持英文大小写字母、数字以及下划线。

默认取值:

不涉及。

task_name

否

String

参数解释:

同步任务名称。

获取方法请参见查询StarRocks数据同步状态信息。

约束限制:

不涉及。

取值范围:

字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。

默认取值:

不涉及。

db_configs

否

Array of DbConfig objects

参数解释:

库配置列表。

约束限制:

不涉及。

tables_configs

否

Array of TablesConfig objects

参数解释:

表配置信息。

约束限制:

不涉及。

table_repl_config

否

TableReplConfig object

参数解释:

表同步配置信息。

约束限制:

不涉及。

target_database_name

否

String

参数解释:

目标数据库名。

获取方法请参见查询数据库列表。

约束限制:

不涉及。

取值范围:

字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。

默认取值:

不涉及。

is_create_task

否

String

参数解释:

是否创建同步任务。

约束限制:

不涉及。

取值范围:

  • true

  • false

默认取值:

不涉及。

表4 DbConfig

参数

是否必选

参数类型

描述

param_name

否

String

参数解释:

参数名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

value

否

String

参数解释:

参数值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表5 TablesConfig

参数

是否必选

参数类型

描述

table_name

否

String

参数解释:

表名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

table_config

否

String

参数解释:

表配置值。

约束限制:

支持order by, key columns, distributed by, partition by, data_model,buckets, replication_num,enable_persistent_index,如果同时设置多个操作,操作之间通过分号连接。

可查看教您快速上手HTAP标准版 了解更多操作语法。

取值范围:

不涉及。

默认取值:

不涉及。

表6 TableReplConfig

参数

是否必选

参数类型

描述

repl_type

否

String

参数解释:

表同步类型。

取值范围:

  • include_tables:白名单。

  • exclude_tables:黑名单。

repl_scope

否

String

参数解释:

表同步范围。

取值范围:

  • all:全量同步。

  • part:部分同步。

tables

否

Array of strings

参数解释:

白名单或黑名单的表范围。

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

source_database_name

String

参数解释:

TaurusDB数据库名。

约束限制:

字符长度限制3~1024位,仅支持英文大小写字母、数字以及下划线。

取值范围:

不涉及。

target_database_name

String

参数解释:

目标数据库名。

约束限制:

字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。

取值范围:

不涉及。

tbl_config_check_results

Array of TableConfigCheckResult objects

参数解释:

表配置检查结果。

约束限制:

不涉及。

取值范围:

不涉及。

task_name

String

参数解释:

同步任务名称。

获取方法请参见查询StarRocks数据同步状态信息。

约束限制:

字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。

取值范围:

不涉及。

表8 TableConfigCheckResult

参数

参数类型

描述

table_name

String

参数解释:

表名。

取值范围:

不涉及。

table_config

String

参数解释:

表配置项。

取值范围:

不涉及。

check_result

String

参数解释:

校验结果。

取值范围:

  • success:校验成功。

  • failed:校验失败。

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/table-config-check

{
  "source_database_name" : "source_database_name",
  "target_database_name" : "target_database_name",
  "db_configs" : [ {
    "param_name" : "enable_chunk_level_dump",
    "value" : "false"
  }, {
    "param_name" : "snapshot_with_lock",
    "value" : "true"
  }, {
    "param_name" : "sync_commit_interval_ms",
    "value" : "5000"
  }, {
    "param_name" : "max_sync_commit_rows",
    "value" : "500000"
  }, {
    "param_name" : "max_sync_commit_bytes",
    "value" : "268435456"
  }, {
    "param_name" : "max_full_sync_task_threads_num",
    "value" : "1"
  }, {
    "param_name" : "max_rows_per_chunk",
    "value" : "0"
  }, {
    "param_name" : "max_bytes_per_chunk",
    "value" : "268435456"
  }, {
    "param_name" : "binlog_expire_logs_seconds",
    "value" : "0"
  } ],
  "table_repl_config" : {
    "repl_type" : "include_tables",
    "repl_scope" : "all",
    "tables" : [ ]
  },
  "tables_configs" : [ {
    "table_name" : "tableName",
    "table_config" : "tableConfig"
  } ],
  "source_instance_id" : "c3d15b62b1c04c1d8ea3cd369084f919in07",
  "is_create_task" : "true",
  "source_node_id" : "b45bb7a5964444ba93cab60a95064f2bno07"
}

响应示例

状态码:200

Success.

{
  "source_database_name" : "source_database_name",
  "target_database_name" : "",
  "task_name" : "task",
  "tbl_config_check_results" : [ {
    "table_name" : "table",
    "table_config" : "order by id",
    "check_result" : "success"
  } ]
}

状态码:400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "实例不存在"
}

SDK代码示例

SDK代码示例如下。

HTAP数据同步表配置校验。

  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
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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 CheckTableConfigSolution {

    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();
        CheckTableConfigRequest request = new CheckTableConfigRequest();
        request.withInstanceId("{instance_id}");
        TableConfigCheckRequestV3 body = new TableConfigCheckRequestV3();
        TableReplConfig tableReplConfigbody = new TableReplConfig();
        tableReplConfigbody.withReplType(TableReplConfig.ReplTypeEnum.fromValue("include_tables"))
            .withReplScope(TableReplConfig.ReplScopeEnum.fromValue("all"));
        List<TablesConfig> listbodyTablesConfigs = new ArrayList<>();
        listbodyTablesConfigs.add(
            new TablesConfig()
                .withTableName("tableName")
                .withTableConfig("tableConfig")
        );
        List<DbConfig> listbodyDbConfigs = new ArrayList<>();
        listbodyDbConfigs.add(
            new DbConfig()
                .withParamName("enable_chunk_level_dump")
                .withValue("false")
        );
        listbodyDbConfigs.add(
            new DbConfig()
                .withParamName("snapshot_with_lock")
                .withValue("true")
        );
        listbodyDbConfigs.add(
            new DbConfig()
                .withParamName("sync_commit_interval_ms")
                .withValue("5000")
        );
        listbodyDbConfigs.add(
            new DbConfig()
                .withParamName("max_sync_commit_rows")
                .withValue("500000")
        );
        listbodyDbConfigs.add(
            new DbConfig()
                .withParamName("max_sync_commit_bytes")
                .withValue("268435456")
        );
        listbodyDbConfigs.add(
            new DbConfig()
                .withParamName("max_full_sync_task_threads_num")
                .withValue("1")
        );
        listbodyDbConfigs.add(
            new DbConfig()
                .withParamName("max_rows_per_chunk")
                .withValue("0")
        );
        listbodyDbConfigs.add(
            new DbConfig()
                .withParamName("max_bytes_per_chunk")
                .withValue("268435456")
        );
        listbodyDbConfigs.add(
            new DbConfig()
                .withParamName("binlog_expire_logs_seconds")
                .withValue("0")
        );
        body.withIsCreateTask("true");
        body.withTargetDatabaseName("target_database_name");
        body.withTableReplConfig(tableReplConfigbody);
        body.withTablesConfigs(listbodyTablesConfigs);
        body.withDbConfigs(listbodyDbConfigs);
        body.withSourceDatabaseName("source_database_name");
        body.withSourceNodeId("b45bb7a5964444ba93cab60a95064f2bno07");
        body.withSourceInstanceId("c3d15b62b1c04c1d8ea3cd369084f919in07");
        request.withBody(body);
        try {
            CheckTableConfigResponse response = client.checkTableConfig(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());
        }
    }
}

Python

HTAP数据同步表配置校验。

 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# 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 = CheckTableConfigRequest()
        request.instance_id = "{instance_id}"
        tableReplConfigbody = TableReplConfig(
            repl_type="include_tables",
            repl_scope="all"
        )
        listTablesConfigsbody = [
            TablesConfig(
                table_name="tableName",
                table_config="tableConfig"
            )
        ]
        listDbConfigsbody = [
            DbConfig(
                param_name="enable_chunk_level_dump",
                value="false"
            ),
            DbConfig(
                param_name="snapshot_with_lock",
                value="true"
            ),
            DbConfig(
                param_name="sync_commit_interval_ms",
                value="5000"
            ),
            DbConfig(
                param_name="max_sync_commit_rows",
                value="500000"
            ),
            DbConfig(
                param_name="max_sync_commit_bytes",
                value="268435456"
            ),
            DbConfig(
                param_name="max_full_sync_task_threads_num",
                value="1"
            ),
            DbConfig(
                param_name="max_rows_per_chunk",
                value="0"
            ),
            DbConfig(
                param_name="max_bytes_per_chunk",
                value="268435456"
            ),
            DbConfig(
                param_name="binlog_expire_logs_seconds",
                value="0"
            )
        ]
        request.body = TableConfigCheckRequestV3(
            is_create_task="true",
            target_database_name="target_database_name",
            table_repl_config=tableReplConfigbody,
            tables_configs=listTablesConfigsbody,
            db_configs=listDbConfigsbody,
            source_database_name="source_database_name",
            source_node_id="b45bb7a5964444ba93cab60a95064f2bno07",
            source_instance_id="c3d15b62b1c04c1d8ea3cd369084f919in07"
        )
        response = client.check_table_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

HTAP数据同步表配置校验。

  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
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := gaussdb.GaussDBClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := gaussdb.NewGaussDBClient(hcClient)

    request := &model.CheckTableConfigRequest{}
	request.InstanceId = "{instance_id}"
	replTypeTableReplConfig:= model.GetTableReplConfigReplTypeEnum().INCLUDE_TABLES
	replScopeTableReplConfig:= model.GetTableReplConfigReplScopeEnum().ALL
	tableReplConfigbody := &model.TableReplConfig{
		ReplType: &replTypeTableReplConfig,
		ReplScope: &replScopeTableReplConfig,
	}
	tableNameTablesConfigs:= "tableName"
	tableConfigTablesConfigs:= "tableConfig"
	var listTablesConfigsbody = []model.TablesConfig{
        {
            TableName: &tableNameTablesConfigs,
            TableConfig: &tableConfigTablesConfigs,
        },
    }
	paramNameDbConfigs:= "enable_chunk_level_dump"
	valueDbConfigs:= "false"
	paramNameDbConfigs1:= "snapshot_with_lock"
	valueDbConfigs1:= "true"
	paramNameDbConfigs2:= "sync_commit_interval_ms"
	valueDbConfigs2:= "5000"
	paramNameDbConfigs3:= "max_sync_commit_rows"
	valueDbConfigs3:= "500000"
	paramNameDbConfigs4:= "max_sync_commit_bytes"
	valueDbConfigs4:= "268435456"
	paramNameDbConfigs5:= "max_full_sync_task_threads_num"
	valueDbConfigs5:= "1"
	paramNameDbConfigs6:= "max_rows_per_chunk"
	valueDbConfigs6:= "0"
	paramNameDbConfigs7:= "max_bytes_per_chunk"
	valueDbConfigs7:= "268435456"
	paramNameDbConfigs8:= "binlog_expire_logs_seconds"
	valueDbConfigs8:= "0"
	var listDbConfigsbody = []model.DbConfig{
        {
            ParamName: &paramNameDbConfigs,
            Value: &valueDbConfigs,
        },
        {
            ParamName: &paramNameDbConfigs1,
            Value: &valueDbConfigs1,
        },
        {
            ParamName: &paramNameDbConfigs2,
            Value: &valueDbConfigs2,
        },
        {
            ParamName: &paramNameDbConfigs3,
            Value: &valueDbConfigs3,
        },
        {
            ParamName: &paramNameDbConfigs4,
            Value: &valueDbConfigs4,
        },
        {
            ParamName: &paramNameDbConfigs5,
            Value: &valueDbConfigs5,
        },
        {
            ParamName: &paramNameDbConfigs6,
            Value: &valueDbConfigs6,
        },
        {
            ParamName: &paramNameDbConfigs7,
            Value: &valueDbConfigs7,
        },
        {
            ParamName: &paramNameDbConfigs8,
            Value: &valueDbConfigs8,
        },
    }
	isCreateTaskTableConfigCheckRequestV3:= "true"
	targetDatabaseNameTableConfigCheckRequestV3:= "target_database_name"
	sourceDatabaseNameTableConfigCheckRequestV3:= "source_database_name"
	sourceNodeIdTableConfigCheckRequestV3:= "b45bb7a5964444ba93cab60a95064f2bno07"
	sourceInstanceIdTableConfigCheckRequestV3:= "c3d15b62b1c04c1d8ea3cd369084f919in07"
	request.Body = &model.TableConfigCheckRequestV3{
		IsCreateTask: &isCreateTaskTableConfigCheckRequestV3,
		TargetDatabaseName: &targetDatabaseNameTableConfigCheckRequestV3,
		TableReplConfig: tableReplConfigbody,
		TablesConfigs: &listTablesConfigsbody,
		DbConfigs: &listDbConfigsbody,
		SourceDatabaseName: &sourceDatabaseNameTableConfigCheckRequestV3,
		SourceNodeId: &sourceNodeIdTableConfigCheckRequestV3,
		SourceInstanceId: &sourceInstanceIdTableConfigCheckRequestV3,
	}
	response, err := client.CheckTableConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

请参见状态码。

错误码

请参见错误码。