Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Checking Table Configurations for HTAP Data Synchronization

Updated on 2025-09-09 GMT+08:00

Online Debugging

CLI Examples

View PDF

Checking Table Configurations for HTAP Data Synchronization

Function

This API is used to check table configurations for HTAP data synchronization. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**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 StarRocks instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** 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 3** Request body parameters
Parameter	Mandatory	Type	Description
source_instance_id	No	String	Definition TaurusDB instance ID. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
source_node_id	No	String	Definition TaurusDB read replica ID. Constraints N/A Range The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed. Default Value N/A
source_database_name	No	String	Definition TaurusDB database name. Constraints N/A Range The value can contain 3 to 1,024 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Default Value N/A
task_name	No	String	Definition Synchronization task name. Constraints N/A Range The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Default Value N/A
db_configs	No	Array of DbConfig objects	Definition Database configurations.
tables_configs	No	Array of TablesConfig objects	Definition Table configurations.
table_repl_config	No	TableReplConfig object	Definition Table synchronization configurations.
target_database_name	No	String	Definition Destination database name. Constraints N/A Range The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Default Value N/A
is_create_task	No	String	Definition Whether to create a synchronization task. Constraints N/A Range true false Default Value N/A

**Table 4** DbConfig
Parameter	Mandatory	Type	Description
param_name	No	String	Definition Parameter name. Range N/A
value	No	String	Definition Parameter value. Range N/A

**Table 5** TablesConfig
Parameter	Mandatory	Type	Description
table_name	No	String	Definition Table name. Constraints N/A Range N/A Default Value N/A
table_config	No	String	Definition Table configuration value. Constraints order by, key columns, distributed by, partition by, data_model, buckets, replication_num, and enable_persistent_index are supported. If multiple operations are set at the same time, separate them with semicolons (;). For more operation syntax, see Getting Started with HTAP Standard Edition. Range N/A Default Value N/A

**Table 6** TableReplConfig
Parameter	Mandatory	Type	Description
repl_type	No	String	Definition Table synchronization type. Range include_tables: whitelist exclude_tables: blacklist
repl_scope	No	String	Definition Table synchronization scope. Range all: all tables part: some tables
tables	No	Array of strings	Definition Whitelisted or blacklisted tables.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
source_database_name	String	Definition TaurusDB database name. Constraints The value can contain 3 to 1,024 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Range N/A
target_database_name	String	Definition Destination database name. Constraints The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Range N/A
tbl_config_check_results	Array of TableConfigCheckResult objects	Definition Table configuration check results. Constraints N/A Range N/A
task_name	String	Definition Synchronization task name. Constraints The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Range N/A

**Table 8** TableConfigCheckResult
Parameter	Type	Description
table_name	String	Definition Table name. Range N/A
table_config	String	Definition Table configuration item. Range N/A
check_result	String	Definition Check results. Range success/failed

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

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

Example Response

Status code: 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"
  } ]
}

Status code: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)

Previous topic: Stopping a Data Synchronization Task for a StarRocks Instance

Next topic: Creating a StarRocks Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot