文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（推荐）/ HTAP-轻量版/ 查看数据同步配置
更新时间：2024-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查看数据同步配置

功能介绍

查看数据同步配置。

URI

GET /v3/{project_id}/instances/{instance_id}/clickhouse/replication/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

ClickHouse实例ID，严格匹配UUID规则。
表2 Query参数

参数

是否必选

参数类型

描述

database_name

是

String

数据库名。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

source_instance_id

String

源实例ID。

source_node_id

String

源实例节点ID。

database_info

ChDatabaseConfigResponse object

数据库配置信息。

table_infos

Array of ChDatabaseTableConfigCheckResult objects

表配置信息。

table_repl_config

ChDatabaseTableReplConfigInfo object

表同步配置信息。

is_tables_change

Boolean

同步任务表是否变化。

new_table_repl_config

ChDatabaseTableReplConfigInfo object

更新的表同步配置信息。

last_error_of_alter_table

String

最近一次alter table的异常信息。
表5 ChDatabaseConfigResponse

参数

参数类型

描述

database_name

String

源数据库名称。

db_config_check_results

Array of ChDatabaseConfigCheckResult objects

源数据库配置检查结果。
表6 ChDatabaseConfigCheckResult

参数

参数类型

描述

param_name

String

库同步配置参数名。

value

String

库同步配置参数值。

check_result

String

校验结果。 取值范围：

  • success：成功
  • fail：失败
表7 ChDatabaseTableConfigCheckResult

参数

参数类型

描述

table_name

String

数据库表名。

table_config

String

表配置项。

允许输入的列操作有：PARTITION BY, COLUMNS, ORDER BY, SAMPLE BY, PRIMARY KEY, TTL

check_result

String

校验结果。
表8 ChDatabaseTableReplConfigInfo

参数

参数类型

描述

repl_type

String

表同步类型。 取值范围：

  • white_list：白名单，此时表范围不能为空。
  • black_list：黑名单，此时表范围为空则选择所有表。

tables

Array of strings

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

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询数据库名为db_test的数据同步配置信息。

GET https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication/config?database_name=db_test

响应示例

状态码： 200

Success.

{
  "source_instance_id" : "77aa4096cb824a61b93dab5ca00ecc8fin07",
  "source_node_id" : "57bfeacf6e8d4eb685ea907372374b35no07",
  "database_info" : {
    "database_name" : "blackwhite_0018_61474479",
    "db_config_check_results" : [ {
      "param_name" : "default_isolation_level",
      "value" : "QUERY_SNAPSHOT",
      "check_result" : "success"
    }, {
      "param_name" : "enable_snapshots",
      "value" : "true",
      "check_result" : "success"
    }, {
      "param_name" : "enable_chunk_level",
      "value" : "true",
      "check_result" : "success"
    }, {
      "param_name" : "max_sync_threads",
      "value" : "1",
      "check_result" : "success"
    }, {
      "param_name" : "treat_numeric_string_as_integer",
      "value" : "false",
      "check_result" : "success"
    }, {
      "param_name" : "min_binlog_expire_logs_seconds",
      "value" : "86400",
      "check_result" : "success"
    }, {
      "param_name" : "max_rows_in_buffer",
      "value" : "2000000",
      "check_result" : "success"
    }, {
      "param_name" : "max_rows_in_buffers",
      "value" : "6000000",
      "check_result" : "success"
    }, {
      "param_name" : "max_bytes_in_buffer",
      "value" : "200000000",
      "check_result" : "success"
    }, {
      "param_name" : "max_bytes_in_buffers",
      "value" : "600000000",
      "check_result" : "success"
    }, {
      "param_name" : "max_flush_data_time",
      "value" : "5000",
      "check_result" : "success"
    } ]
  },
  "table_infos" : [ ],
  "table_repl_config" : {
    "repl_type" : "black_list",
    "tables" : [ ]
  },
  "is_tables_change" : false,
  "new_table_repl_config" : {
    "repl_type" : null,
    "tables" : null
  },
  "last_error_of_alter_table" : null
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： HTAP-轻量版