文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ HTAP数据同步表配置校验- CheckTableConfig
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

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规则。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为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

参数解释：

同步任务名称。

约束限制：

不涉及。

取值范围：

字符长度限制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

参数解释：

同步任务名称。

约束限制：

字符长度限制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" : "source_instance_id",
  "is_create_task" : "true",
  "source_node_id" : "source_node_id"
}

响应示例

状态码：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" : "实例不存在"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版