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

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

功能介绍

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

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/instances/{instance_id}/clickhouse/replication/database-parameter

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

instance_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us

  • zh-cn

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

db_parameters

Array of ChDatabaseParameterInfo objects

库参数信息。

表4 ChDatabaseParameterInfo

参数

参数类型

描述

param_name

String

参数名称。

data_type

String

参数类型。

default_value

String

参数默认值。

value_range

String

参数取值范围。

description

String

参数描述。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

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

GET https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication/database-parameter

响应示例

状态码: 200

Success.

{
  "db_parameters" : [ {
    "param_name" : "default_isolation_level",
    "data_type" : "String",
    "default_value" : "QUERY_SNAPSHOT",
    "value_range" : "READ_COMMITTED|READ_UNCOMMITTED|QUERY_RAW|QUERY_SNAPSHOT",
    "description" : "默认隔离级别,仅对MaterializeMySQL 引擎有效,可以是“read_uncommitted”,这意味着没有 MVCC 支持,“read_committed”,它保留查询(包括子查询)中的事务完整性,或“query_snapshot”,它保留事务完整性并以牺牲数据新鲜度为代价删除重复和删除的行。"
  }, {
    "param_name" : "enable_snapshots",
    "data_type" : "String",
    "default_value" : "true",
    "value_range" : "true|false",
    "description" : "创建快照以支持mvcc_isolation_level='query_snapshot'"
  }, {
    "param_name" : "enable_chunk_level",
    "data_type" : "String",
    "default_value" : "true",
    "value_range" : "true|false",
    "description" : "支持chunk级别的并行复制,复制会更快"
  }, {
    "param_name" : "max_sync_threads",
    "data_type" : "Integer",
    "default_value" : "1",
    "value_range" : "1-2",
    "description" : "全量复制最大线程数"
  }, {
    "param_name" : "treat_numeric_string_as_integer",
    "data_type" : "String",
    "default_value" : "false",
    "value_range" : "true|false",
    "description" : "允许在全量同步期间块级任务生成中将数字字符串视为整数"
  }, {
    "param_name" : "min_binlog_expire_logs_seconds",
    "data_type" : "Integer",
    "default_value" : "86400",
    "value_range" : "0-2592000",
    "description" : "允许binlog保存的最小时长,如果binlog保存的时间小于该阈值,同步会报失败。0表示不做限制。"
  }, {
    "param_name" : "max_rows_in_buffer",
    "data_type" : "Integer",
    "default_value" : "2000000",
    "value_range" : "1-10000000",
    "description" : "内存中允许缓存数据的最大行数(对于单表和无法查询的缓存数据而言)。当行数超过时,数据将被物化"
  }, {
    "param_name" : "max_rows_in_buffers",
    "data_type" : "Integer",
    "default_value" : "6000000",
    "value_range" : "1-10000000",
    "description" : "内存中允许缓存的最大行数(用于数据库和无法查询的缓存数据而言)。当行数超过时,数据将被物化"
  }, {
    "param_name" : "max_bytes_in_buffer",
    "data_type" : "Integer",
    "default_value" : "200000000",
    "value_range" : "1-1000000000",
    "description" : "数据在内存中允许缓存的最大字节数(对于单表和无法查询的缓存数据)。当字节数超过时,数据将被物化"
  }, {
    "param_name" : "max_bytes_in_buffers",
    "data_type" : "Integer",
    "default_value" : "600000000",
    "value_range" : "1-1000000000",
    "description" : "数据在内存中允许缓存的最大字节数(对于数据库和无法查询的缓存数据)。当字节数超过时,数据将被物化"
  }, {
    "param_name" : "max_flush_data_time",
    "data_type" : "Integer",
    "default_value" : "5000",
    "value_range" : "1-10000",
    "description" : "允许数据缓存在内存中的最大时长(毫秒)"
  } ]
}

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

    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();
        ListClickHouseDataBaseParameterRequest request = new ListClickHouseDataBaseParameterRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListClickHouseDataBaseParameterResponse response = client.listClickHouseDataBaseParameter(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 = ListClickHouseDataBaseParameterRequest()
        request.instance_id = "{instance_id}"
        response = client.list_click_house_data_base_parameter(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.ListClickHouseDataBaseParameterRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListClickHouseDataBaseParameter(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.

错误码

请参见错误码

相关文档