HTAP数据同步库配置校验
URI
POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-config-check
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
|
instance_id |
是 |
String |
StarRocks实例ID，严格匹配UUID规则。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
|
X-Language |
是 |
String |
请求语言类型。默认en-us。 取值范围：
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
source_instance_id |
否 |
String |
GaussDB(for MySQL)实例ID。 |
|
source_node_id |
否 |
String |
GaussDB(for MySQL)只读节点ID。如为空，则取GaussDB(for MySQL)主节点ID |
|
source_database_name |
否 |
String |
GaussDB(for MySQL)数据库名。字符长度限制3~1024位，仅支持英文大小写字母、数字以及下划线。 |
|
target_database_name |
否 |
String |
目标数据库名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 |
|
task_name |
否 |
String |
同步任务名称。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 |
|
db_configs |
否 |
Array of DbConfig objects |
库配置列表。 |
|
table_repl_config |
否 |
TableReplConfig object |
表配置信息。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
source_database_name |
String |
目标数据库名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线_。 |
|
source_db_config_check_results |
Array of DbConfigCheckResult objects |
GaussDB(for MySQL)数据库配置检查结果。 |
|
target_database_name |
String |
目标数据库名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 |
|
target_db_config_check_results |
Array of DbConfigCheckResult objects |
目标数据库配置检查结果。 |
|
task_name |
String |
同步任务名称。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
param_name |
String |
参数名，字符长度限制3~128位。 |
|
value |
String |
参数值，字符长度限制1~64位。 |
|
check_result |
String |
校验结果。 可选范围：
|
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-config-check
{
"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_replconfig" : {
"repl_type" : "include_tables",
"repl_scope" : "all",
"tables" : [ ]
},
"source_instance_id" : "source_instance_id",
"source_node_id" : "source_node_id"
}
响应示例
状态码： 200
Success.
{
"source_database_name" : "source_database_name",
"target_database_name" : "",
"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"
} ],
"target_db_config_check_results" : [ ]
}
状态码： 400
Client error.
{
"error_code" : "DBS.200022",
"error_msg" : "实例不存在"
}
状态码
请参见状态码。
错误码
请参见错误码。
