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:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration
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 in17. Only letters and digits are allowed. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
task_name |
Yes |
String |
Definition Name of the data synchronization task. Constraints Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Range The value can contain 3 to 128 characters. 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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
source_instance_id |
String |
Definition TaurusDB instance ID. Range N/A |
source_node_id |
String |
Definition TaurusDB node ID. Range N/A |
database_info |
DataBaseInfo object |
Definition TaurusDB database configuration information. Range N/A |
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 |
Definition Name of the destination database. Range The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. |
is_tables_change |
Boolean |
Definition Whether there is any change to the synchronization scope (tables to be synchronized). Range N/A |
last_error_of_alter_table |
String |
Definition Exception about the latest ALTER TABLE operation. Range N/A |
Parameter |
Type |
Description |
---|---|---|
database_name |
String |
Database name. |
db_config_check_results |
Array of DbConfigCheckResult objects |
Database configuration check result. |
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 results. Values:
|
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 success/failed |
Parameter |
Type |
Description |
---|---|---|
repl_type |
String |
Table synchronization type.
|
repl_scope |
String |
Table synchronization scope.
|
tables |
Array of strings |
Tables listed on the whitelist or blacklist. |
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
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_infos" : [ ], "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.
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