文档首页/ 云数据库 TaurusDB/ API参考/ API(推荐)/ HTAP-标准版/ 查询StarRocks数据同步的库参数配置
更新时间:2024-12-16 GMT+08:00
分享

查询StarRocks数据同步的库参数配置

功能介绍

查询StarRocks数据同步的库参数配置。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

instance_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

offset

String

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

limit

String

查询记录数。

请求参数

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

参数

参数类型

描述

db_parameters

Array of DbParameter objects

库参数信息。

表5 DbParameter

参数

参数类型

描述

param_name

String

参数名称。

data_type

String

参数类型。

default_value

String

参数默认值。

value_range

String

参数取值范围。

description

String

参数描述。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询StarRocks实例instance_id数据同步的库参数配置。

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters

响应示例

状态码: 200

Success.

{
  "db_parameters" : [ {
    "param_name" : "enable_chunk_level_dump",
    "data_type" : "String",
    "default_value" : "false",
    "value_range" : "true|false",
    "description" : "是否启用分片复制"
  }, {
    "param_name" : "snapshot_with_lock",
    "data_type" : "String",
    "default_value" : "true",
    "value_range" : "true|false",
    "description" : "获取全量快照时是否加锁,默认加锁"
  }, {
    "param_name" : "sync_commit_interval_ms",
    "data_type" : "Integer",
    "default_value" : "5000",
    "value_range" : "1000-60000",
    "description" : "批量提交超时时间,超时或buffer满就会提交数据"
  }, {
    "param_name" : "max_sync_commit_rows",
    "data_type" : "Integer",
    "default_value" : "500000",
    "value_range" : "500000-2000000",
    "description" : "每次提交最大行数"
  }, {
    "param_name" : "max_sync_commit_bytes",
    "data_type" : "Integer",
    "default_value" : "268435456",
    "value_range" : "10485760-1610612736",
    "description" : "每次提交最大字节数"
  }, {
    "param_name" : "max_full_sync_task_threads_num",
    "data_type" : "Integer",
    "default_value" : "1",
    "value_range" : "1-2",
    "description" : "全量同步线程数"
  }, {
    "param_name" : "max_rows_per_chunk",
    "data_type" : "Integer",
    "default_value" : "0",
    "value_range" : "0-1000000",
    "description" : "每个分片的最大行数"
  }, {
    "param_name" : "max_bytes_per_chunk",
    "data_type" : "Integer",
    "default_value" : "268435456",
    "value_range" : "33554432-1073741824",
    "description" : "每个分片最大字节数"
  }, {
    "param_name" : "binlog_expire_logs_seconds",
    "data_type" : "Integer",
    "default_value" : "86400",
    "value_range" : "0-604800",
    "description" : "binlog保留时间,0表示不做限制,且该值要小于等于MySQL保留时间。"
  } ]
}

状态码: 400

Client error.

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

SDK代码示例

SDK代码示例如下。

Java

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

    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();
        ListStarRocksDbParametersRequest request = new ListStarRocksDbParametersRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListStarRocksDbParametersResponse response = client.listStarRocksDbParameters(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());
        }
    }
}

Python

 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 = ListStarRocksDbParametersRequest()
        request.instance_id = "{instance_id}"
        response = client.list_star_rocks_db_parameters(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
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.ListStarRocksDbParametersRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListStarRocksDbParameters(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档