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

查询StarRocks数据同步状态信息 - ListStarRocksDataReplications

功能介绍

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

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:htapInstance:getReplication

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:htapInstance:list

    -

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规则。

获取方法请参见查询HTAP实例列表。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,后缀为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" : "实例不存在"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;


public class ListStarRocksDataReplicationsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        ListStarRocksDataReplicationsRequest request = new ListStarRocksDataReplicationsRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListStarRocksDataReplicationsResponse response = client.listStarRocksDataReplications(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListStarRocksDataReplicationsRequest()
        request.instance_id = "{instance_id}"
        response = client.list_star_rocks_data_replications(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := gaussdb.GaussDBClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := gaussdb.NewGaussDBClient(hcClient)

    request := &model.ListStarRocksDataReplicationsRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListStarRocksDataReplications(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

请参见状态码。

错误码

请参见错误码。