数据同步表配置校验
功能介绍
数据同步表配置校验。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/instances/{instance_id}/clickhouse/replication/table-check
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
ClickHouse实例ID,严格匹配UUID规则。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source_instance_id |
是 |
String |
源实例ID。 |
source_node_id |
否 |
String |
源节点ID。GaussDB(for MySQL)只读节点ID。如为空,则取GaussDB(for MySQL)主节点ID。 |
source_database_name |
是 |
String |
源数据库名。 |
db_configs |
是 |
Array of ChDatabaseConfigsInfo objects |
库配置列表。 |
tables_configs |
是 |
Array of ChDatabaseTablesConfigsInfo objects |
表配置信息。 |
table_repl_config |
是 |
表同步配置信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
param_name |
是 |
String |
库同步配置参数名。可通过“查询数据同步的库参数配置”接口查询。 |
value |
是 |
String |
库同步配置参数值。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
source_database_name |
String |
源数据库名。 |
table_config_check_results |
Array of ChDatabaseTableConfigCheckResult objects |
表配置检查结果。 |
参数 |
参数类型 |
描述 |
---|---|---|
table_name |
String |
数据库表名。 |
table_config |
String |
表配置项。 允许输入的列操作有:PARTITION BY, COLUMNS, ORDER BY, SAMPLE BY, PRIMARY KEY, TTL |
check_result |
String |
校验结果。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
数据同步表配置校验。
POST https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication/table-check { "source_database_name" : "blackwhite_0017_22525694", "db_configs" : [ { "param_name" : "default_isolation_level", "value" : "QUERY_SNAPSHOT" }, { "param_name" : "enable_snapshots", "value" : "true" }, { "param_name" : "enable_chunk_level", "value" : "true" }, { "param_name" : "max_sync_threads", "value" : "1" }, { "param_name" : "treat_numeric_string_as_integer", "value" : "false" }, { "param_name" : "min_binlog_expire_logs_seconds", "value" : "86400" }, { "param_name" : "max_rows_in_buffer", "value" : "2000000" }, { "param_name" : "max_rows_in_buffers", "value" : "6000000" }, { "param_name" : "max_bytes_in_buffer", "value" : "200000000" }, { "param_name" : "max_bytes_in_buffers", "value" : "600000000" }, { "param_name" : "max_flush_data_time", "value" : "5000" } ], "tables_configs" : [ { "table_name" : "sbtest100", "table_config" : "ORDER BY id" } ], "table_repl_config" : { "repl_type" : "white_list", "tables" : [ ] }, "source_instance_id" : "77aa4096cb824a61b93dab5ca00ecc8fin07", "source_node_id" : "57bfeacf6e8d4eb685ea907372374b35no07" }
响应示例
状态码: 200
Success.
{ "source_database_name" : "blackwhite_0017_22525694", "table_config_check_results" : [ { "table_name" : "sbtest100", "table_config" : "ORDER BY id", "check_result" : "Check Override Table Failed" } ] }
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
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.*; import java.util.List; import java.util.ArrayList; public class CheckClickHouseTableConfigSolution { 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(); CheckClickHouseTableConfigRequest request = new CheckClickHouseTableConfigRequest(); request.withInstanceId("{instance_id}"); CheckChDatabaseTableConfigRequestBody body = new CheckChDatabaseTableConfigRequestBody(); ChDatabaseTableReplConfigInfo tableReplConfigbody = new ChDatabaseTableReplConfigInfo(); tableReplConfigbody.withReplType("white_list"); List<ChDatabaseTablesConfigsInfo> listbodyTablesConfigs = new ArrayList<>(); listbodyTablesConfigs.add( new ChDatabaseTablesConfigsInfo() .withTableName("sbtest100") .withTableConfig("ORDER BY id") ); List<ChDatabaseConfigsInfo> listbodyDbConfigs = new ArrayList<>(); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("default_isolation_level") .withValue("QUERY_SNAPSHOT") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("enable_snapshots") .withValue("true") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("enable_chunk_level") .withValue("true") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("max_sync_threads") .withValue("1") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("treat_numeric_string_as_integer") .withValue("false") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("min_binlog_expire_logs_seconds") .withValue("86400") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("max_rows_in_buffer") .withValue("2000000") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("max_rows_in_buffers") .withValue("6000000") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("max_bytes_in_buffer") .withValue("200000000") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("max_bytes_in_buffers") .withValue("600000000") ); listbodyDbConfigs.add( new ChDatabaseConfigsInfo() .withParamName("max_flush_data_time") .withValue("5000") ); body.withTableReplConfig(tableReplConfigbody); body.withTablesConfigs(listbodyTablesConfigs); body.withDbConfigs(listbodyDbConfigs); body.withSourceDatabaseName("blackwhite_0017_22525694"); body.withSourceNodeId("57bfeacf6e8d4eb685ea907372374b35no07"); body.withSourceInstanceId("77aa4096cb824a61b93dab5ca00ecc8fin07"); request.withBody(body); try { CheckClickHouseTableConfigResponse response = client.checkClickHouseTableConfig(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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# 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 = CheckClickHouseTableConfigRequest() request.instance_id = "{instance_id}" tableReplConfigbody = ChDatabaseTableReplConfigInfo( repl_type="white_list" ) listTablesConfigsbody = [ ChDatabaseTablesConfigsInfo( table_name="sbtest100", table_config="ORDER BY id" ) ] listDbConfigsbody = [ ChDatabaseConfigsInfo( param_name="default_isolation_level", value="QUERY_SNAPSHOT" ), ChDatabaseConfigsInfo( param_name="enable_snapshots", value="true" ), ChDatabaseConfigsInfo( param_name="enable_chunk_level", value="true" ), ChDatabaseConfigsInfo( param_name="max_sync_threads", value="1" ), ChDatabaseConfigsInfo( param_name="treat_numeric_string_as_integer", value="false" ), ChDatabaseConfigsInfo( param_name="min_binlog_expire_logs_seconds", value="86400" ), ChDatabaseConfigsInfo( param_name="max_rows_in_buffer", value="2000000" ), ChDatabaseConfigsInfo( param_name="max_rows_in_buffers", value="6000000" ), ChDatabaseConfigsInfo( param_name="max_bytes_in_buffer", value="200000000" ), ChDatabaseConfigsInfo( param_name="max_bytes_in_buffers", value="600000000" ), ChDatabaseConfigsInfo( param_name="max_flush_data_time", value="5000" ) ] request.body = CheckChDatabaseTableConfigRequestBody( table_repl_config=tableReplConfigbody, tables_configs=listTablesConfigsbody, db_configs=listDbConfigsbody, source_database_name="blackwhite_0017_22525694", source_node_id="57bfeacf6e8d4eb685ea907372374b35no07", source_instance_id="77aa4096cb824a61b93dab5ca00ecc8fin07" ) response = client.check_click_house_table_config(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 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
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.CheckClickHouseTableConfigRequest{} request.InstanceId = "{instance_id}" tableReplConfigbody := &model.ChDatabaseTableReplConfigInfo{ ReplType: "white_list", } var listTablesConfigsbody = []model.ChDatabaseTablesConfigsInfo{ { TableName: "sbtest100", TableConfig: "ORDER BY id", }, } var listDbConfigsbody = []model.ChDatabaseConfigsInfo{ { ParamName: "default_isolation_level", Value: "QUERY_SNAPSHOT", }, { ParamName: "enable_snapshots", Value: "true", }, { ParamName: "enable_chunk_level", Value: "true", }, { ParamName: "max_sync_threads", Value: "1", }, { ParamName: "treat_numeric_string_as_integer", Value: "false", }, { ParamName: "min_binlog_expire_logs_seconds", Value: "86400", }, { ParamName: "max_rows_in_buffer", Value: "2000000", }, { ParamName: "max_rows_in_buffers", Value: "6000000", }, { ParamName: "max_bytes_in_buffer", Value: "200000000", }, { ParamName: "max_bytes_in_buffers", Value: "600000000", }, { ParamName: "max_flush_data_time", Value: "5000", }, } sourceNodeIdCheckChDatabaseTableConfigRequestBody:= "57bfeacf6e8d4eb685ea907372374b35no07" request.Body = &model.CheckChDatabaseTableConfigRequestBody{ TableReplConfig: tableReplConfigbody, TablesConfigs: listTablesConfigsbody, DbConfigs: listDbConfigsbody, SourceDatabaseName: "blackwhite_0017_22525694", SourceNodeId: &sourceNodeIdCheckChDatabaseTableConfigRequestBody, SourceInstanceId: "77aa4096cb824a61b93dab5ca00ecc8fin07", } response, err := client.CheckClickHouseTableConfig(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. |
错误码
请参见错误码。