文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ 查询StarRocks数据同步配置信息- ListStarRocksDataReplicationConfig
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询StarRocks数据同步配置信息 - ListStarRocksDataReplicationConfig

功能介绍

查询StarRocks数据同步配置信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:htapInstance:getReplicationConfig

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:htapInstance:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

StarRocks实例ID，严格匹配UUID规则。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in17，且长度为36个字符。

默认取值：

不涉及。
表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

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

source_instance_id

String

参数解释：

TaurusDB实例ID。

取值范围：

不涉及。

source_node_id

String

参数解释：

TaurusDB节点ID。

取值范围：

不涉及。

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

参数解释：

同步任务表是否变化。

取值范围：

  • true：变化。

  • false：不变化。

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

参数解释：

表名。

取值范围：

不涉及。

table_config

String

参数解释：

表配置项。

取值范围：

不涉及。

check_result

String

参数解释：

校验结果。

取值范围：

  • success：成功。

  • failed：失败。
表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://{endpoint}/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_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" : "实例不存在"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版