文档首页/ 云数据库 GaussDB(for MySQL)/ 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/configuration

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

StarRocks实例ID，严格匹配UUID规则。
表2 Query参数

参数

是否必选

参数类型

描述

task_name

是

String

数据同步任务名。 字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

是

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

source_instance_id

String

GaussDB(for MySQL)实例ID。

source_node_id

String

GaussDB(for MySQL)节点ID。

database_info

DataBaseInfo object

GaussDB(for MySQL)数据库配置信息。

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的异常信息。
表5 DataBaseInfo

参数

参数类型

描述

database_name

String

数据库名称。

db_config_check_results

Array of DbConfigCheckResult objects

数据库配置检查结果。
表6 DbConfigCheckResult

参数

参数类型

描述

param_name

String

参数名，字符长度限制3~128位。

value

String

参数值，字符长度限制1~64位。

check_result

String

校验结果。

可选范围：

  • success
  • fail
表7 TableConfigCheckResult

参数

参数类型

描述

table_name

String

表名。

  • 最小长度：2
  • 最大长度：1024

table_config

String

表配置项。

  • 最小长度：2
  • 最大长度：1024

check_result

String

校验结果。取值：success或fail

  • 最小长度：2
  • 最大长度：10
表8 TableReplConfig

参数

参数类型

描述

repl_type

String

表同步类型。

  • include_tables：白名单。
  • exclude_tables：黑名单。

repl_scope

String

表同步范围。

  • all：全量同步。
  • part：部分同步。

tables

Array of strings

白名单或黑名单的表范围。

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询任务名为taskName的数据同步配置信息。

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration?task_name=taskName

响应示例

状态码： 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_info" : [ ],
  "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" : "实例不存在"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版