修改StarRocks数据同步配置
URI
PUT /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: StarRocks实例ID,严格匹配UUID规则。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in17,且长度为36个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Content-Type |
是 |
String |
参数解释: 内容类型。 约束限制: 不涉及。 取值范围: application/json。 默认取值: application/json。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source_instance_id |
否 |
String |
参数解释: TaurusDB实例ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
source_node_id |
否 |
String |
参数解释: TaurusDB只读节点ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为no07,长度为36个字符。 默认取值: 不涉及。 |
source_database_name |
否 |
String |
参数解释: TaurusDB数据库名。 约束限制: 不涉及。 取值范围: 字符长度限制3~1024位,仅支持英文大小写字母、数字以及下划线。 默认取值: 不涉及。 |
task_name |
否 |
String |
参数解释: 数据同步任务名称。 约束限制: 不涉及。 取值范围: 长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 默认取值: 不涉及。 |
db_configs |
否 |
Array of DbConfig objects |
参数解释: 库配置列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
tables_configs |
否 |
Array of TablesConfig objects |
参数解释: 表配置信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
table_repl_config |
否 |
TableReplConfig object |
参数解释: 表同步配置信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
target_database_name |
否 |
String |
参数解释: 目标数据库名。 约束限制: 不涉及。 取值范围: 长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 默认取值: 不涉及。 |
is_instance_level_sync |
否 |
String |
参数解释: 是否支持实例级同步。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
database_repl_scope |
否 |
String |
参数解释: 库同步范围。 约束限制: 不涉及。 取值范围: 默认取值: part。 |
is_support_reg_exp |
否 |
String |
参数解释: 是否支持通配符。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
param_name |
否 |
String |
参数解释: 参数名。 取值范围: 不涉及。 |
value |
否 |
String |
参数解释: 参数值。 取值范围: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
table_name |
否 |
String |
参数解释: 表名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
table_config |
否 |
String |
参数解释: 表配置值。 约束限制: 支持order by, key columns, distributed by, partition by, data_model,buckets, replication_num,enable_persistent_index,如果同时设置多个操作,操作之间通过分号连接。 可查看教您快速上手HTAP标准版了解更多操作语法。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
source_database_name |
String |
参数解释: TaurusDB数据库名。 取值范围: 长度限制3~1024位,仅支持英文大小写字母、数字以及下划线。 |
target_database_name |
String |
参数解释: 目标数据库名。 取值范围: 长度限制3~1024位,仅支持英文大小写字母、数字以及下划线。 |
source_db_config_check_results |
Array of DbConfigCheckResult objects |
参数解释: TaurusDB数据库配置检查结果。 取值范围: 不涉及。 |
tbl_config_check_results |
Array of TableConfigCheckResult objects |
参数解释: 表配置检查结果。 取值范围: 不涉及。 |
task_name |
String |
参数解释: 同步任务名称。 取值范围: 长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 |
job_id |
String |
参数解释: 修改同步配置工作流ID。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
param_name |
String |
参数解释: 参数名。 取值范围: 字符长度限制3~128位。 |
value |
String |
参数解释: 参数值。 取值范围: 字符长度限制1~64位。 |
check_result |
String |
参数解释: 校验结果。 取值范围: |
参数 |
参数类型 |
描述 |
---|---|---|
table_name |
String |
参数解释: 表名。 取值范围: 不涉及。 |
table_config |
String |
参数解释: 表配置项。 取值范围: 不涉及。 |
check_result |
String |
参数解释: 校验结果。 取值范围:
|
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及。 |
请求示例
PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication { "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_repl_config" : { "repl_type" : "include_tables", "repl_scope" : "all", "tables" : [ ] }, "tables_configs" : { "table_name" : "tableName", "table_config" : "tableConfig" }, "source_instance_id" : "source_instance_id", "is_create_task" : "true", "source_node_id" : "source_node_id" }
响应示例
状态码:200
Success.
{ "source_database_name" : "source_database_name", "target_database_name" : "target_database_name", "job_id" : "job_id", "task_name" : "task", "tbl_config_check_results" : [ { "table_name" : "table", "table_config" : "order by id", "check_result" : "success" } ], "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" } ] }
状态码:400
Client error.
{ "error_code" : "DBS.200022", "error_msg" : "实例不存在" }
状态码
请参见状态码。
错误码
请参见错误码。