本文导读

展开导读

文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-轻量版/ 查询数据同步的库参数配置

查询数据同步的库参数配置

更新时间：2024-09-11 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

查询数据同步的库参数配置。

调用接口前，您需要了解API认证鉴权。
调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

URI

GET /v3/{project_id}/instances/{instance_id}/clickhouse/replication/database-parameter

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一Region下的project ID。获取方法请参见获取项目ID。
instance_id	是	String	ClickHouse实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
X-Language	否	String	请求语言类型。默认en-us。取值范围： en-us zh-cn

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
db_parameters	Array of ChDatabaseParameterInfo objects	库参数信息。

表4 ChDatabaseParameterInfo
参数	参数类型	描述
param_name	String	参数名称。
data_type	String	参数类型。
default_value	String	参数默认值。
value_range	String	参数取值范围。
description	String	参数描述。

状态码： 400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。

状态码： 500

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。

请求示例

查询实例数据同步的库参数配置。

GET https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication/database-parameter

响应示例

状态码： 200

Success.

{
  "db_parameters" : [ {
    "param_name" : "default_isolation_level",
    "data_type" : "String",
    "default_value" : "QUERY_SNAPSHOT",
    "value_range" : "READ_COMMITTED|READ_UNCOMMITTED|QUERY_RAW|QUERY_SNAPSHOT",
    "description" : "默认隔离级别，仅对MaterializeMySQL 引擎有效,可以是“read_uncommitted”，这意味着没有 MVCC 支持，“read_committed”，它保留查询（包括子查询）中的事务完整性，或“query_snapshot”，它保留事务完整性并以牺牲数据新鲜度为代价删除重复和删除的行。"
  }, {
    "param_name" : "enable_snapshots",
    "data_type" : "String",
    "default_value" : "true",
    "value_range" : "true|false",
    "description" : "创建快照以支持mvcc_isolation_level='query_snapshot'"
  }, {
    "param_name" : "enable_chunk_level",
    "data_type" : "String",
    "default_value" : "true",
    "value_range" : "true|false",
    "description" : "支持chunk级别的并行复制，复制会更快"
  }, {
    "param_name" : "max_sync_threads",
    "data_type" : "Integer",
    "default_value" : "1",
    "value_range" : "1-2",
    "description" : "全量复制最大线程数"
  }, {
    "param_name" : "treat_numeric_string_as_integer",
    "data_type" : "String",
    "default_value" : "false",
    "value_range" : "true|false",
    "description" : "允许在全量同步期间块级任务生成中将数字字符串视为整数"
  }, {
    "param_name" : "min_binlog_expire_logs_seconds",
    "data_type" : "Integer",
    "default_value" : "86400",
    "value_range" : "0-2592000",
    "description" : "允许binlog保存的最小时长，如果binlog保存的时间小于该阈值，同步会报失败。0表示不做限制。"
  }, {
    "param_name" : "max_rows_in_buffer",
    "data_type" : "Integer",
    "default_value" : "2000000",
    "value_range" : "1-10000000",
    "description" : "内存中允许缓存数据的最大行数（对于单表和无法查询的缓存数据而言）。当行数超过时，数据将被物化"
  }, {
    "param_name" : "max_rows_in_buffers",
    "data_type" : "Integer",
    "default_value" : "6000000",
    "value_range" : "1-10000000",
    "description" : "内存中允许缓存的最大行数（用于数据库和无法查询的缓存数据而言）。当行数超过时，数据将被物化"
  }, {
    "param_name" : "max_bytes_in_buffer",
    "data_type" : "Integer",
    "default_value" : "200000000",
    "value_range" : "1-1000000000",
    "description" : "数据在内存中允许缓存的最大字节数（对于单表和无法查询的缓存数据）。当字节数超过时，数据将被物化"
  }, {
    "param_name" : "max_bytes_in_buffers",
    "data_type" : "Integer",
    "default_value" : "600000000",
    "value_range" : "1-1000000000",
    "description" : "数据在内存中允许缓存的最大字节数（对于数据库和无法查询的缓存数据）。当字节数超过时，数据将被物化"
  }, {
    "param_name" : "max_flush_data_time",
    "data_type" : "Integer",
    "default_value" : "5000",
    "value_range" : "1-10000",
    "description" : "允许数据缓存在内存中的最大时长(毫秒)"
  } ]
}

状态码

状态码	描述
200	Success.
400	Client error.
500	Server error.

错误码

请参见错误码。

父主题： HTAP-轻量版

上一篇：查看数据同步配置

下一篇：创建实例

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消