Easily Switch Between Product Types

You can click the drop-down list box to switch between different product types.

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Checking Table Configurations for HTAP Data Synchronization

Checking Table Configurations for HTAP Data Synchronization

Function

This API is used to check table configurations for HTAP data synchronization. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/table-config-check

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

StarRocks instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

source_instance_id

No

String

TaurusDB instance ID.

source_node_id

No

String

TaurusDB read replica ID.

source_database_name

No

String

Name of the TaurusDB database. The value can contain 3 to 1024 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

task_name

No

String

Synchronization task name. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

db_configs

No

Array of DbConfig objects

Database configurations.

tables_configs

No

Array of TablesConfig objects

Table configurations.

table_repl_config

No

TableReplConfig object

Table synchronization configurations.

target_database_name

No

String

Name of the destination database. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

is_create_task

No

String

Whether to create a synchronization task.

Table 4 DbConfig

Parameter

Mandatory

Type

Description

param_name

No

String

Parameter name.

value

No

String

Parameter value.

Table 5 TablesConfig

Parameter

Mandatory

Type

Description

table_name

No

String

Table name.

table_config

No

String

Table configuration item.

Table 6 TableReplConfig

Parameter

Mandatory

Type

Description

repl_type

No

String

Table synchronization type. include_tables: whitelist; exclude_tables: blacklist.

repl_scope

No

String

Table synchronization scope. all: full synchronization; part: partial synchronization.

tables

No

Array of strings

Whitelisted or blacklisted tables.

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

source_database_name

String

Name of the TaurusDB database. The value can contain 3 to 1024 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

target_database_name

String

Name of the destination database. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

tbl_config_check_results

Array of TableConfigCheckResult objects

Table configuration check results.

task_name

String

Synchronization task name. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

Table 8 TableConfigCheckResult

Parameter

Type

Description

table_name

String

Table name.

table_config

String

Table configuration item.

check_result

String

Check results. The value can be success or failed.

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

POST https://{localhost}/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."
}

Example SDK Code

The example SDK code is as follows.

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
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());
        }
    }
}

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
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)

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
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: &paramNameDbConfigs,
            Value: &valueDbConfigs,
        },
        {
            ParamName: &paramNameDbConfigs1,
            Value: &valueDbConfigs1,
        },
        {
            ParamName: &paramNameDbConfigs2,
            Value: &valueDbConfigs2,
        },
        {
            ParamName: &paramNameDbConfigs3,
            Value: &valueDbConfigs3,
        },
        {
            ParamName: &paramNameDbConfigs4,
            Value: &valueDbConfigs4,
        },
        {
            ParamName: &paramNameDbConfigs5,
            Value: &valueDbConfigs5,
        },
        {
            ParamName: &paramNameDbConfigs6,
            Value: &valueDbConfigs6,
        },
        {
            ParamName: &paramNameDbConfigs7,
            Value: &valueDbConfigs7,
        },
        {
            ParamName: &paramNameDbConfigs8,
            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)
    }
}

More Programming Languages

For SDK code examples in more programming languages, visit API Explorer and click the Sample Code tab. Code examples can be automatically generated.

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback