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
Situation Awareness
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)/ Querying Configurations of a StarRocks Data Synchronization Task

Querying Configurations of a StarRocks Data Synchronization Task

Function

This API is used to query configurations of a StarRocks data synchronization task. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration

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.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

task_name

Yes

String

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

Request Parameters

Table 3 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

Yes

String

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

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

source_instance_id

String

TaurusDB instance ID.

source_node_id

String

TaurusDB node ID.

database_info

DataBaseInfo object

TaurusDB database configuration information.

table_infos

Array of TableConfigCheckResult objects

Table configurations.

table_repl_config

TableReplConfig object

Table synchronization configurations.

new_table_repl_config

TableReplConfig object

Updated table synchronization configurations.

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.

is_tables_change

Boolean

Whether there is any change to the synchronization scope (tables to be synchronized).

last_error_of_alter_table

String

Exception about the latest ALTER TABLE operation.

Table 5 DataBaseInfo

Parameter

Type

Description

database_name

String

Database name.

db_config_check_results

Array of DbConfigCheckResult objects

Database configuration check result.

Table 6 DbConfigCheckResult

Parameter

Type

Description

param_name

String

Parameter name. The name can contain 3 to 128 characters.

value

String

Parameter value. The value can contain 1 to 64 characters.

check_result

String

Check result.

Values:

  • success
  • fail
Table 7 TableConfigCheckResult

Parameter

Type

Description

table_name

String

Table name.

  • Minimum length: 2 characters
  • Maximum length: 1024 characters

table_config

String

Table configuration item.

  • Minimum length: 2 characters
  • Maximum length: 1024 characters

check_result

String

Check result. Value: success or fail

  • Minimum length: 2 characters
  • Maximum length: 10 characters
Table 8 TableReplConfig

Parameter

Type

Description

repl_type

String

Table synchronization type.

  • include_tables: whitelist
  • exclude_tables: blacklist

repl_scope

String

Table synchronization scope.

  • all: all tables
  • part: some tables

tables

Array of strings

Tables listed on the whitelist or blacklist.

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

Querying configurations of the data synchronization task taskName

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration?task_name=taskName

Example Response

Status code: 200

Success.

{
  "source_instance_id" : "source_instance_id",
  "target_database_name" : "target_database_name",
  "source_node_id" : "source_node_id",
  "database_info" : {
    "database_name" : "database_name",
    "db_config_check_results" : [ {
      "param_name" : "default_isolation_level",
      "value" : "QUERY_SNAPSHOT",
      "check_result" : "success"
    }, {
      "param_name" : "enable_snapshots",
      "value" : "true",
      "check_result" : "failed"
    } ]
  },
  "table_info" : [ ],
  "table_repl_config" : {
    "repl_type" : "exclude_tables",
    "repl_scope" : "all",
    "tables" : [ ]
  },
  "new_table_repl_config" : { },
  "is_tables_change" : false,
  "last_error_of_alter_table" : ""
}

Status code: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Status Code

For details, see Status Codes.

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