文档首页/ 云数据库 TaurusDB/ API参考/ API(推荐)/ HTAP-标准版/ 查询StarRocks数据同步状态信息
更新时间:2025-09-09 GMT+08:00

查询StarRocks数据同步状态信息

功能介绍

查询StarRocks数据同步状态信息。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

String

参数解释

查询记录数。

约束限制

必须为整数,不能为负数。

取值范围

1-100。

默认取值

100。

offset

String

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制

必须为整数,不能为负数。

取值范围

非负整数。

默认取值

0。

请求参数

表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参数

参数

参数类型

描述

total_count

String

参数解释

查询数据同步任务数。

取值范围

不涉及。

replications

Array of StarRocksReplicationInfo objects

参数解释

数据同步任务信息。

取值范围

不涉及。

ext_text

String

参数解释

扩展字段。

取值范围

不涉及。

表5 StarRocksReplicationInfo

参数

参数类型

描述

source_database

String

参数解释

TaurusDB数据库。

取值范围

字符串长度限制3-1024位。

target_database

String

参数解释

目标数据库。

取值范围

字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。

task_name

String

参数解释

同步任务名。

取值范围

字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。

status

String

参数解释

当前状态。

取值范围

Yes:正常,No:异常。

stage

String

参数解释

同步阶段。

取值范围

  • wait:等待同步。
  • incremental:增量同步。
  • full:全量同步。
  • cancelled:删除。
  • paused:暂停同步。

percentage

String

参数解释

进度百分比。

取值范围

不涉及。

catchup_stage

String

参数解释

追赶阶段。

取值范围

  • wait:等待同步。
  • incremental:增量同步。
  • full:全量同步。
  • cancelled:删除。
  • paused:暂停同步。

catchup_percentage

String

参数解释

追赶进度百分比。

取值范围

不涉及。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询第一页的前10个同步任务。

GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication?offset=1&limit=10

响应示例

状态码: 200

Success.

{
  "total_count" : 1,
  "replications" : [ {
    "source_database" : "source_database",
    "target_database" : "target_database",
    "task_name" : "task_name",
    "status" : "Yes",
    "stage" : "Incremental",
    "percentage" : 100,
    "catchup_stage" : null,
    "catchup_percentage" : 0
  } ],
  "ext_text" : null
}

状态码: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "实例不存在"
}

状态码

请参见状态码

错误码

请参见错误码