HTAP数据同步库配置校验
功能介绍
HTAP数据同步库配置校验。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-config-check
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
StarRocks实例ID,严格匹配UUID规则。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language |
是 |
String |
请求语言类型。默认en-us。 取值范围:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source_instance_id |
否 |
String |
TaurusDB实例ID。 |
source_node_id |
否 |
String |
TaurusDB只读节点ID。 |
source_database_name |
否 |
String |
TaurusDB数据库名。字符长度限制3~1024位,仅支持英文大小写字母、数字以及下划线。 |
target_database_name |
否 |
String |
目标数据库名。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 |
task_name |
否 |
String |
同步任务名称。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 |
db_configs |
否 |
Array of DbConfig objects |
库配置列表。 |
table_repl_config |
否 |
TableReplConfig object |
表配置信息。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
source_database_name |
String |
目标数据库名。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线_。 |
source_db_config_check_results |
Array of DbConfigCheckResult objects |
TaurusDB数据库配置检查结果。 |
target_database_name |
String |
目标数据库名。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 |
target_db_config_check_results |
Array of DbConfigCheckResult objects |
目标数据库配置检查结果。 |
task_name |
String |
同步任务名称。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。 |
参数 |
参数类型 |
描述 |
---|---|---|
param_name |
String |
参数名,字符长度限制3~128位。 |
value |
String |
参数值,字符长度限制1~64位。 |
check_result |
String |
校验结果。 可选范围
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-config-check { "source_database_name" : "source_database_name", "target_database_name" : "target_database_name", "db_configs" : [ { "param_name" : "enable_chunk_level_dump", "value" : "false" }, { "param_name" : "snapshot_with_lock", "value" : "true" }, { "param_name" : "sync_commit_interval_ms", "value" : "5000" }, { "param_name" : "max_sync_commit_rows", "value" : "500000" }, { "param_name" : "max_sync_commit_bytes", "value" : "268435456" }, { "param_name" : "max_full_sync_task_threads_num", "value" : "1" }, { "param_name" : "max_rows_per_chunk", "value" : "0" }, { "param_name" : "max_bytes_per_chunk", "value" : "268435456" }, { "param_name" : "binlog_expire_logs_seconds", "value" : "0" } ], "table_repl_config" : { "repl_type" : "include_tables", "repl_scope" : "all", "tables" : [ ] }, "source_instance_id" : "source_instance_id", "source_node_id" : "source_node_id" }
响应示例
状态码: 200
Success.
{ "source_database_name" : "source_database_name", "target_database_name" : "", "source_db_config_check_results" : [ { "param_name" : "enable_chunk_level_dump", "value" : "false", "check_result" : "success" }, { "param_name" : "snapshot_with_lock", "value" : "true", "check_result" : "success" } ], "target_db_config_check_results" : [ ] }
状态码: 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 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 |
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 CheckDataBaseConfigSolution { 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(); CheckDataBaseConfigRequest request = new CheckDataBaseConfigRequest(); request.withInstanceId("{instance_id}"); DbConfigCheckRequestV3 body = new DbConfigCheckRequestV3(); TableReplConfig tableReplConfigbody = new TableReplConfig(); tableReplConfigbody.withReplType(TableReplConfig.ReplTypeEnum.fromValue("include_tables")) .withReplScope(TableReplConfig.ReplScopeEnum.fromValue("all")); List<DbConfig> listbodyDbConfigs = new ArrayList<>(); listbodyDbConfigs.add( new DbConfig() .withParamName("enable_chunk_level_dump") .withValue("false") ); listbodyDbConfigs.add( new DbConfig() .withParamName("snapshot_with_lock") .withValue("true") ); listbodyDbConfigs.add( new DbConfig() .withParamName("sync_commit_interval_ms") .withValue("5000") ); listbodyDbConfigs.add( new DbConfig() .withParamName("max_sync_commit_rows") .withValue("500000") ); listbodyDbConfigs.add( new DbConfig() .withParamName("max_sync_commit_bytes") .withValue("268435456") ); listbodyDbConfigs.add( new DbConfig() .withParamName("max_full_sync_task_threads_num") .withValue("1") ); listbodyDbConfigs.add( new DbConfig() .withParamName("max_rows_per_chunk") .withValue("0") ); listbodyDbConfigs.add( new DbConfig() .withParamName("max_bytes_per_chunk") .withValue("268435456") ); listbodyDbConfigs.add( new DbConfig() .withParamName("binlog_expire_logs_seconds") .withValue("0") ); body.withTableReplConfig(tableReplConfigbody); body.withDbConfigs(listbodyDbConfigs); body.withTargetDatabaseName("target_database_name"); body.withSourceDatabaseName("source_database_name"); body.withSourceNodeId("source_node_id"); body.withSourceInstanceId("source_instance_id"); request.withBody(body); try { CheckDataBaseConfigResponse response = client.checkDataBaseConfig(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 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 |
# 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 = CheckDataBaseConfigRequest() request.instance_id = "{instance_id}" tableReplConfigbody = TableReplConfig( repl_type="include_tables", repl_scope="all" ) listDbConfigsbody = [ DbConfig( param_name="enable_chunk_level_dump", value="false" ), DbConfig( param_name="snapshot_with_lock", value="true" ), DbConfig( param_name="sync_commit_interval_ms", value="5000" ), DbConfig( param_name="max_sync_commit_rows", value="500000" ), DbConfig( param_name="max_sync_commit_bytes", value="268435456" ), DbConfig( param_name="max_full_sync_task_threads_num", value="1" ), DbConfig( param_name="max_rows_per_chunk", value="0" ), DbConfig( param_name="max_bytes_per_chunk", value="268435456" ), DbConfig( param_name="binlog_expire_logs_seconds", value="0" ) ] request.body = DbConfigCheckRequestV3( table_repl_config=tableReplConfigbody, db_configs=listDbConfigsbody, target_database_name="target_database_name", source_database_name="source_database_name", source_node_id="source_node_id", source_instance_id="source_instance_id" ) response = client.check_data_base_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) |
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 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 |
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.CheckDataBaseConfigRequest{} request.InstanceId = "{instance_id}" replTypeTableReplConfig:= model.GetTableReplConfigReplTypeEnum().INCLUDE_TABLES replScopeTableReplConfig:= model.GetTableReplConfigReplScopeEnum().ALL tableReplConfigbody := &model.TableReplConfig{ ReplType: &replTypeTableReplConfig, ReplScope: &replScopeTableReplConfig, } paramNameDbConfigs:= "enable_chunk_level_dump" valueDbConfigs:= "false" paramNameDbConfigs1:= "snapshot_with_lock" valueDbConfigs1:= "true" paramNameDbConfigs2:= "sync_commit_interval_ms" valueDbConfigs2:= "5000" paramNameDbConfigs3:= "max_sync_commit_rows" valueDbConfigs3:= "500000" paramNameDbConfigs4:= "max_sync_commit_bytes" valueDbConfigs4:= "268435456" paramNameDbConfigs5:= "max_full_sync_task_threads_num" valueDbConfigs5:= "1" paramNameDbConfigs6:= "max_rows_per_chunk" valueDbConfigs6:= "0" paramNameDbConfigs7:= "max_bytes_per_chunk" valueDbConfigs7:= "268435456" paramNameDbConfigs8:= "binlog_expire_logs_seconds" valueDbConfigs8:= "0" var listDbConfigsbody = []model.DbConfig{ { ParamName: ¶mNameDbConfigs, Value: &valueDbConfigs, }, { ParamName: ¶mNameDbConfigs1, Value: &valueDbConfigs1, }, { ParamName: ¶mNameDbConfigs2, Value: &valueDbConfigs2, }, { ParamName: ¶mNameDbConfigs3, Value: &valueDbConfigs3, }, { ParamName: ¶mNameDbConfigs4, Value: &valueDbConfigs4, }, { ParamName: ¶mNameDbConfigs5, Value: &valueDbConfigs5, }, { ParamName: ¶mNameDbConfigs6, Value: &valueDbConfigs6, }, { ParamName: ¶mNameDbConfigs7, Value: &valueDbConfigs7, }, { ParamName: ¶mNameDbConfigs8, Value: &valueDbConfigs8, }, } targetDatabaseNameDbConfigCheckRequestV3:= "target_database_name" sourceDatabaseNameDbConfigCheckRequestV3:= "source_database_name" sourceNodeIdDbConfigCheckRequestV3:= "source_node_id" sourceInstanceIdDbConfigCheckRequestV3:= "source_instance_id" request.Body = &model.DbConfigCheckRequestV3{ TableReplConfig: tableReplConfigbody, DbConfigs: &listDbConfigsbody, TargetDatabaseName: &targetDatabaseNameDbConfigCheckRequestV3, SourceDatabaseName: &sourceDatabaseNameDbConfigCheckRequestV3, SourceNodeId: &sourceNodeIdDbConfigCheckRequestV3, SourceInstanceId: &sourceInstanceIdDbConfigCheckRequestV3, } response, err := client.CheckDataBaseConfig(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. |
错误码
请参见错误码。