Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying StarRocks Data Synchronization Configurations by Destination Database
Updated on 2026-01-05 GMT+08:00

Querying StarRocks Data Synchronization Configurations by Destination Database

Function

This API is used to query StarRocks data synchronization configurations by destination database. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    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/{database}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

StarRocks instance ID, which is compliant with the UUID format.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in17. Only letters and digits are allowed.

Default Value

N/A

database

Yes

String

Definition

Name of the destination database.

Constraints

N/A

Range

The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

source_instance_id

String

Definition

TaurusDB instance ID.

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

source_node_id

String

Definition

TaurusDB node ID.

Range

The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed.

database_info

DataBaseInfo object

Definition

TaurusDB database configuration.

Range

N/A

table_infos

Array of TableConfigCheckResult objects

Definition

Table configurations.

Range

N/A

table_repl_config

TableReplConfig object

Definition

Table synchronization configurations.

Range

N/A

new_table_repl_config

TableReplConfig object

Definition

Updated table synchronization configurations.

Range

N/A

target_database_name

String

Definition

Name of the destination database.

Range

The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

is_tables_change

Boolean

Definition

Whether there is any change to the synchronization scope (tables to be synchronized).

Range

  • true: There is a change.

  • false: There is no change.

last_error_of_alter_table

String

Definition

Exception about the latest ALTER TABLE operation.

Range

N/A

Table 4 DataBaseInfo

Parameter

Type

Description

database_name

String

Definition

Database name.

Range

N/A

db_config_check_results

Array of DbConfigCheckResult objects

Definition

Database configuration check results.

Range

N/A

Table 5 DbConfigCheckResult

Parameter

Type

Description

param_name

String

Definition

Parameter name.

Range

The value can contain 3 to 128 characters.

value

String

Definition

Parameter value.

Range

The value can contain 1 to 64 characters.

check_result

String

Definition

Check results.

Range

  • success

  • fail

Table 6 TableConfigCheckResult

Parameter

Type

Description

table_name

String

Definition

Table name.

Range

N/A

table_config

String

Definition

Table configuration item.

Range

N/A

check_result

String

Definition

Check results.

Range

  • success

  • failed

Table 7 TableReplConfig

Parameter

Type

Description

repl_type

String

Definition

Table synchronization type.

Range

  • include_tables: whitelist

  • exclude_tables: blacklist

repl_scope

String

Definition

Table synchronization scope.

Range

  • all: all tables

  • part: some tables

tables

Array of strings

Definition

Whitelisted or blacklisted tables.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying data synchronization configurations of the database destination database

GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration/database

Example Response

Status code: 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" : ""
}

Status code: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

SDK Sample Code

The SDK sample code is as follows.

 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
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 ListStarRocksDataReplicationConfigByDataBaseSolution {

    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();
        ListStarRocksDataReplicationConfigByDataBaseRequest request = new ListStarRocksDataReplicationConfigByDataBaseRequest();
        request.withInstanceId("{instance_id}");
        request.withDatabase("{database}");
        try {
            ListStarRocksDataReplicationConfigByDataBaseResponse response = client.listStarRocksDataReplicationConfigByDataBase(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
33
# 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 = ListStarRocksDataReplicationConfigByDataBaseRequest()
        request.instance_id = "{instance_id}"
        request.database = "{database}"
        response = client.list_star_rocks_data_replication_config_by_data_base(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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.