Checking Table Configurations for HTAP Data Synchronization
Function
This API is used to check table configurations for HTAP data synchronization. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
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.
URI
POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/table-config-check
|
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 in07. Only letters and digits are allowed. Default Value N/A |
Request 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 Default Value en-us |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
source_instance_id |
No |
String |
Definition TaurusDB instance ID. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A |
|
source_node_id |
No |
String |
Definition TaurusDB read replica ID. Constraints N/A Range The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed. Default Value N/A |
|
source_database_name |
No |
String |
Definition TaurusDB database name. Constraints N/A Range The value can contain 3 to 1,024 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Default Value N/A |
|
task_name |
No |
String |
Definition Synchronization task name. 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 |
|
db_configs |
No |
Array of DbConfig objects |
Definition Database configurations. |
|
tables_configs |
No |
Array of TablesConfig objects |
Definition Table configurations. |
|
table_repl_config |
No |
TableReplConfig object |
Definition Table synchronization configurations. |
|
target_database_name |
No |
String |
Definition Destination database name. 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 |
|
is_create_task |
No |
String |
Definition Whether to create a synchronization task. Constraints N/A Range Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
param_name |
No |
String |
Definition Parameter name. Range N/A |
|
value |
No |
String |
Definition Parameter value. Range N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
table_name |
No |
String |
Definition Table name. Constraints N/A Range N/A Default Value N/A |
|
table_config |
No |
String |
Definition Table configuration value. Constraints order by, key columns, distributed by, partition by, data_model, buckets, replication_num, and enable_persistent_index are supported. If multiple operations are set at the same time, separate them with semicolons (;). For more operation syntax, see Getting Started with HTAP Standard Edition. Range N/A Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
source_database_name |
String |
Definition TaurusDB database name. Constraints The value can contain 3 to 1,024 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Range N/A |
|
target_database_name |
String |
Definition Destination database name. Constraints The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Range N/A |
|
tbl_config_check_results |
Array of TableConfigCheckResult objects |
Definition Table configuration check results. Constraints N/A Range N/A |
|
task_name |
String |
Definition Synchronization task name. Constraints The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Range N/A |
|
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 |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Request
POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/table-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" : [ ]
},
"tables_configs" : {
"table_name" : "tableName",
"table_config" : "tableConfig"
},
"source_instance_id" : "source_instance_id",
"is_create_task" : "true",
"source_node_id" : "source_node_id"
}
Example Response
Status code: 200
Success.
{
"source_database_name" : "source_database_name",
"target_database_name" : "",
"task_name" : "task",
"tbl_config_check_results" : [ {
"table_name" : "table",
"table_config" : "order by id",
"check_result" : "success"
} ]
}
Status code: 400
Client error.
{
"error_code" : "DBS.200022",
"error_msg" : "Instance not found."
}
SDK Sample Code
The SDK sample code is as follows.
Checking table configurations for HTAP data synchronization
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 |
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 CheckTableConfigSolution { 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(); CheckTableConfigRequest request = new CheckTableConfigRequest(); request.withInstanceId("{instance_id}"); TableConfigCheckRequestV3 body = new TableConfigCheckRequestV3(); 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.withIsCreateTask("true"); body.withTargetDatabaseName("target_database_name"); body.withTableReplConfig(tableReplConfigbody); body.withDbConfigs(listbodyDbConfigs); body.withSourceDatabaseName("source_database_name"); body.withSourceNodeId("source_node_id"); body.withSourceInstanceId("source_instance_id"); request.withBody(body); try { CheckTableConfigResponse response = client.checkTableConfig(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()); } } } |
Checking table configurations for HTAP data synchronization
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 |
# 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 = CheckTableConfigRequest() 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 = TableConfigCheckRequestV3( is_create_task="true", target_database_name="target_database_name", table_repl_config=tableReplConfigbody, db_configs=listDbConfigsbody, source_database_name="source_database_name", source_node_id="source_node_id", source_instance_id="source_instance_id" ) response = client.check_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) |
Checking table configurations for HTAP data synchronization
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 |
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.CheckTableConfigRequest{} 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, }, } isCreateTaskTableConfigCheckRequestV3:= "true" targetDatabaseNameTableConfigCheckRequestV3:= "target_database_name" sourceDatabaseNameTableConfigCheckRequestV3:= "source_database_name" sourceNodeIdTableConfigCheckRequestV3:= "source_node_id" sourceInstanceIdTableConfigCheckRequestV3:= "source_instance_id" request.Body = &model.TableConfigCheckRequestV3{ IsCreateTask: &isCreateTaskTableConfigCheckRequestV3, TargetDatabaseName: &targetDatabaseNameTableConfigCheckRequestV3, TableReplConfig: tableReplConfigbody, DbConfigs: &listDbConfigsbody, SourceDatabaseName: &sourceDatabaseNameTableConfigCheckRequestV3, SourceNodeId: &sourceNodeIdTableConfigCheckRequestV3, SourceInstanceId: &sourceInstanceIdTableConfigCheckRequestV3, } response, err := client.CheckTableConfig(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot