文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ 查询StarRocks数据同步的库参数配置
更新时间：2024-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

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

功能介绍

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

URI

GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

StarRocks实例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 DbParameter objects

库参数信息。
表4 DbParameter

参数

参数类型

描述

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

错误描述。

请求示例

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

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters

响应示例

状态码： 200

Success.

{
  "db_parameters" : [ {
    "param_name" : "enable_chunk_level_dump",
    "data_type" : "String",
    "default_value" : "false",
    "value_range" : "true|false",
    "description" : "是否启用分片复制"
  }, {
    "param_name" : "snapshot_with_lock",
    "data_type" : "String",
    "default_value" : "true",
    "value_range" : "true|false",
    "description" : "获取全量快照时是否加锁，默认加锁"
  }, {
    "param_name" : "sync_commit_interval_ms",
    "data_type" : "Integer",
    "default_value" : "5000",
    "value_range" : "1000-60000",
    "description" : "批量提交超时时间，超时或buffer满就会提交数据"
  }, {
    "param_name" : "max_sync_commit_rows",
    "data_type" : "Integer",
    "default_value" : "500000",
    "value_range" : "500000-2000000",
    "description" : "每次提交最大行数"
  }, {
    "param_name" : "max_sync_commit_bytes",
    "data_type" : "Integer",
    "default_value" : "268435456",
    "value_range" : "10485760-1610612736",
    "description" : "每次提交最大字节数"
  }, {
    "param_name" : "max_full_sync_task_threads_num",
    "data_type" : "Integer",
    "default_value" : "1",
    "value_range" : "1-2",
    "description" : "全量同步线程数"
  }, {
    "param_name" : "max_rows_per_chunk",
    "data_type" : "Integer",
    "default_value" : "0",
    "value_range" : "0-1000000",
    "description" : "每个分片的最大行数"
  }, {
    "param_name" : "max_bytes_per_chunk",
    "data_type" : "Integer",
    "default_value" : "268435456",
    "value_range" : "33554432-1073741824",
    "description" : "每个分片最大字节数"
  }, {
    "param_name" : "binlog_expire_logs_seconds",
    "data_type" : "Integer",
    "default_value" : "86400",
    "value_range" : "0-604800",
    "description" : "binlog保留时间，0表示不做限制，且该值要小于等于MySQL保留时间。"
  } ]
}

状态码： 400

Client error.

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

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版