Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Checking Database Configurations for HTAP Data Synchronization
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF

Checking Database Configurations for HTAP Data Synchronization

Function

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

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

StarRocks instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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.

X-Language

Yes

String

Request language type. The default value is en-us. Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

source_instance_id

No

String

GaussDB(for MySQL) instance ID.

source_node_id

No

String

GaussDB(for MySQL) read replica ID. If this parameter is left blank, the ID of the primary node is used.

source_database_name

No

String

Name of the GaussDB(for MySQL) database. The value can contain 3 to 1024 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

target_database_name

No

String

Name of the destination database. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

task_name

No

String

Synchronization task name. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

db_configs

No

Array of DbConfig objects

Database configurations.

table_repl_config

No

TableReplConfig object

Table configurations.
Table 4 DbConfig

Parameter

Mandatory

Type

Description

param_name

No

String

Parameter name.

value

No

String

Parameter value.
Table 5 TableReplConfig

Parameter

Mandatory

Type

Description

repl_type

No

String

Table synchronization type.

  • include_tables: whitelist
  • exclude_tables: blacklist

repl_scope

No

String

Table synchronization scope.

  • all: all tables
  • part: some tables

tables

No

Array of strings

Tables listed on the whitelist or blacklist.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

source_database_name

String

Name of the destination database. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

source_db_config_check_results

Array of DbConfigCheckResult objects

Check result of the GaussDB(for MySQL) database configurations.

target_database_name

String

Name of the destination database. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

target_db_config_check_results

Array of DbConfigCheckResult objects

Check result of the destination database configurations.

task_name

String

Synchronization task name. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.
Table 7 DbConfigCheckResult

Parameter

Type

Description

param_name

String

Parameter name. The name can contain 3 to 128 characters.

value

String

Parameter value. The value can contain 1 to 64 characters.

check_result

String

Check result.

Values:

  • success
  • fail

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

POST https://{localhost}/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_replconfig" : {
    "repl_type" : "include_tables",
    "repl_scope" : "all",
    "tables" : [ ]
  },
  "source_instance_id" : "source_instance_id",
  "source_node_id" : "source_node_id"
}

Example Response

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

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)