更新时间:2025-07-29 GMT+08:00

HTAP数据同步库配置校验

功能介绍

HTAP数据同步库配置校验。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为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位,仅支持英文大小写字母、数字以及下划线。

target_database_name

String

参数解释

目标数据库名。

取值范围

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

task_name

String

参数解释

同步任务名称。

取值范围

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

db_configs

Array of DbConfig objects

参数解释

库配置列表。

table_repl_config

TableReplConfig object

参数解释

表配置信息。

表4 DbConfig

参数

是否必选

参数类型

描述

param_name

String

参数解释

参数名。

取值范围

不涉及。

value

String

参数解释

参数值。

取值范围

不涉及。

表5 TableReplConfig

参数

是否必选

参数类型

描述

repl_type

String

参数解释

表同步类型。

取值范围

  • include_tables:白名单。

  • exclude_tables:黑名单。

repl_scope

String

参数解释

表同步范围。

取值范围

  • all:全量同步。

  • part:部分同步。

tables

Array of strings

参数解释

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

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

source_database_name

String

参数解释

目标数据库名。

取值范围

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

source_db_config_check_results

Array of DbConfigCheckResult objects

参数解释

TaurusDB数据库配置检查结果。

target_database_name

String

参数解释

目标数据库名。

取值范围

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

target_db_config_check_results

Array of DbConfigCheckResult objects

参数解释

目标数据库配置检查结果。

task_name

String

参数解释

同步任务名称。

取值范围

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

表7 DbConfigCheckResult

参数

参数类型

描述

param_name

String

参数解释

参数名。

取值范围

字符长度限制3~128位。

value

String

参数解释

参数值。

取值范围

字符长度限制1~64位。

check_result

String

参数解释

校验结果。

取值范围

  • success:成功。

  • fail:失败。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-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" : [ ]
  },
  "source_instance_id" : "source_instance_id",
  "source_node_id" : "source_node_id"
}

响应示例

状态码: 200

Success.

{
  "source_database_name" : "source_database_name",
  "target_database_name" : "",
  "source_db_config_check_results" : [ {
    "param_name" : "enable_chunk_level_dump",
    "value" : "false",
    "check_result" : "success"
  }, {
    "param_name" : "snapshot_with_lock",
    "value" : "true",
    "check_result" : "success"
  } ],
  "target_db_config_check_results" : [ ]
}

状态码: 400

Client error.

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

状态码

请参见状态码

错误码

请参见错误码