查询StarRocks数据同步的库参数配置 - ListStarRocksDbParameters
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
URI
GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
|
instance_id |
是 |
String |
参数解释： StarRocks实例ID，严格匹配UUID规则。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，后缀为in17，且长度为36个字符。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
add_task_scenario |
否 |
String |
参数解释： 新增子任务的场景，用于区分库参数是否支持修改。 约束限制： 非必填。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
offset |
否 |
String |
参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 约束限制： 不涉及。 取值范围： ≥0。 默认取值： 0。 |
|
limit |
否 |
String |
参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： 1-100。 默认取值： 1。 |
|
main_task_name |
否 |
String |
参数解释： 新增子任务相应的主任务名。 约束限制： 非必填。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
X-Language |
否 |
String |
参数解释： 请求语言类型。 约束限制： 不涉及。 取值范围： 默认取值： en-us。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
db_parameters |
Array of DbParameter objects |
参数解释： 库参数信息。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
param_name |
String |
约束限制： 参数名称。 取值范围： 不涉及。 |
|
data_type |
String |
约束限制： 参数类型。 取值范围： 不涉及。 |
|
default_value |
String |
约束限制： 参数默认值。 取值范围： 不涉及。 |
|
value_range |
String |
约束限制： 参数取值范围。 取值范围： 不涉及。 |
|
description |
String |
约束限制： 参数描述。 取值范围： 不涉及。 |
|
is_modifiable |
String |
参数解释： 新增子任务的场景，用于区分库参数是否支持修改。 取值范围： 不涉及。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
查询StarRocks实例instance_id数据同步的库参数配置。
GET https://{endpoint}/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" : "是否启用分片复制",
"is_modifiable" : "Yes"
}, {
"param_name" : "snapshot_with_lock",
"data_type" : "String",
"default_value" : "true",
"value_range" : "true|false",
"description" : "获取全量快照时是否加锁，默认加锁",
"is_modifiable" : "Yes"
}, {
"param_name" : "sync_commit_interval_ms",
"data_type" : "Integer",
"default_value" : "5000",
"value_range" : "1000-60000",
"description" : "批量提交超时时间，超时或buffer满就会提交数据",
"is_modifiable" : "Yes"
}, {
"param_name" : "max_sync_commit_rows",
"data_type" : "Integer",
"default_value" : "500000",
"value_range" : "500000-2000000",
"description" : "每次提交最大行数",
"is_modifiable" : "Yes"
}, {
"param_name" : "max_sync_commit_bytes",
"data_type" : "Integer",
"default_value" : "268435456",
"value_range" : "10485760-1610612736",
"description" : "每次提交最大字节数",
"is_modifiable" : "Yes"
}, {
"param_name" : "max_full_sync_task_threads_num",
"data_type" : "Integer",
"default_value" : "1",
"value_range" : "1-2",
"description" : "全量同步线程数",
"is_modifiable" : "Yes"
}, {
"param_name" : "max_rows_per_chunk",
"data_type" : "Integer",
"default_value" : "0",
"value_range" : "0-1000000",
"description" : "每个分片的最大行数",
"is_modifiable" : "Yes"
}, {
"param_name" : "max_bytes_per_chunk",
"data_type" : "Integer",
"default_value" : "268435456",
"value_range" : "33554432-1073741824",
"description" : "每个分片最大字节数",
"is_modifiable" : "Yes"
}, {
"param_name" : "binlog_expire_logs_seconds",
"data_type" : "Integer",
"default_value" : "86400",
"value_range" : "0-604800",
"description" : "binlog保留时间，0表示不做限制，且该值要小于等于TaurusDB保留时间。",
"is_modifiable" : "Yes"
} ]
}
状态码： 400
Client error.
{
"error_code" : "DBS.200022",
"error_msg" : "实例不存在"
}
状态码
请参见状态码。
错误码
请参见错误码。
