按目标库查询StarRocks数据同步配置信息
URI
GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration/{database}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: StarRocks实例ID,严格匹配UUID规则。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in17,且长度为36个字符。 默认值: 不涉及。 |
database |
是 |
String |
参数解释: 目标数据库名。 约束限制: 不涉及。 取值范围: 字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 默认值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
source_instance_id |
String |
参数解释: TaurusDB实例ID。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 |
source_node_id |
String |
参数解释: TaurusDB节点ID。 取值范围: 只能由英文字母、数字组成,前面为UUID,后缀为no07,长度为36个字符。 |
database_info |
DataBaseInfo object |
参数解释: TaurusDB数据库配置信息。 取值范围: 不涉及。 |
table_infos |
Array of TableConfigCheckResult objects |
参数解释: 表配置信息。 取值范围: 不涉及。 |
table_repl_config |
TableReplConfig object |
参数解释: 表同步配置信息。 取值范围: 不涉及。 |
new_table_repl_config |
TableReplConfig object |
参数解释: 更新的表同步配置信息。 取值范围: 不涉及。 |
target_database_name |
String |
参数解释: 目标数据库名。 取值范围: 字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 |
is_tables_change |
Boolean |
参数解释: 同步任务表是否变化。 取值范围: |
last_error_of_alter_table |
String |
参数解释: 最近一次alter table的异常信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
database_name |
String |
参数解释: 数据库名称。 取值范围: 不涉及。 |
db_config_check_results |
Array of DbConfigCheckResult objects |
参数解释: 数据库配置检查结果。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
param_name |
String |
参数解释: 参数名。 取值范围: 字符长度限制3~128位。 |
value |
String |
参数解释: 参数值。 取值范围: 字符长度限制1~64位。 |
check_result |
String |
参数解释: 校验结果。 取值范围: |
参数 |
参数类型 |
描述 |
---|---|---|
table_name |
String |
参数解释: 表名。 取值范围: 不涉及。 |
table_config |
String |
参数解释: 表配置项。 取值范围: 不涉及。 |
check_result |
String |
参数解释: 校验结果。 取值范围: |
参数 |
参数类型 |
描述 |
---|---|---|
repl_type |
String |
参数解释: 表同步类型。 取值范围: |
repl_scope |
String |
参数解释: 表同步范围。 取值范围: |
tables |
Array of strings |
参数解释: 白名单或黑名单的表范围。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
查询目标库名为database的数据同步配置信息。
GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration/database
响应示例
状态码:200
Success.
{ "source_instance_id" : "source_instance_id", "target_database_name" : "target_database_name", "source_node_id" : "source_node_id", "database_info" : { "database_name" : "database_name", "db_config_check_results" : [ { "param_name" : "default_isolation_level", "value" : "QUERY_SNAPSHOT", "check_result" : "success" }, { "param_name" : "enable_snapshots", "value" : "true", "check_result" : "failed" } ] }, "table_infos" : [ ], "table_repl_config" : { "repl_type" : "exclude_tables", "repl_scope" : "all", "tables" : [ ] }, "new_table_repl_config" : { }, "is_tables_change" : false, "last_error_of_alter_table" : "" }
状态码:400
Client error.
{ "error_code" : "DBS.200022", "error_msg" : "实例不存在" }
状态码
请参见状态码。
错误码
请参见错误码。