Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Data Synchronization Tasks of a StarRocks Instance
Updated on 2025-07-31 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Data Synchronization Tasks of a StarRocks Instance

Function

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

URI

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

Table 1 URI parameters

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
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

String

Definition

Number of records to be queried.

Constraints

The value must be an integer and cannot be a negative number.

Range

1–100

Default Value

100

offset

No

String

Definition

Index offset. The query starts from the next piece of data indexed by this parameter.

Constraints

The value must be an integer and cannot be a negative number.

Range

0 or a positive integer

Default Value

0

Request Parameters

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

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

String

Definition

Total number of data synchronization tasks.

Range

N/A

replications

Array of StarRocksReplicationInfo objects

Definition

Information about data synchronization tasks.

Range

N/A

ext_text

String

Definition

Extended field.

Range

N/A
Table 5 StarRocksReplicationInfo

Parameter

Type

Description

source_database

String

Definition

TaurusDB database.

Range

The value can contain 3 to 1,024 characters.

target_database

String

Definition

Destination database.

Range

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

task_name

String

Definition

Synchronization task name.

Range

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

status

String

Definition

Current status.

Range

Yes: normal; No: abnormal

stage

String

Definition

Synchronization stage.

Range

  • wait: waiting for synchronization
  • incremental: incremental synchronization
  • full: full synchronization
  • cancelled: synchronization cancelled
  • paused: synchronization paused

percentage

String

Definition

Progress percentage.

Range

N/A

catchup_stage

String

Definition

Catchup stage.

Range

  • wait: waiting for synchronization
  • incremental: incremental synchronization
  • full: full synchronization
  • cancelled: synchronization cancelled
  • paused: synchronization paused

catchup_percentage

String

Definition

Catchup progress percentage.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the first 10 synchronization tasks on the first page

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication?offset=1&limit=10

Example Response

Status code: 200

Success.

{
  "total_count" : 1,
  "replications" : [ {
    "source_database" : "source_database",
    "target_database" : "target_database",
    "task_name" : "task_name",
    "status" : "Yes",
    "stage" : "Incremental",
    "percentage" : 100,
    "catchup_stage" : null,
    "catchup_percentage" : 0
  } ],
  "ext_text" : null
}

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.

Parent topic: HTAP (Standard Edition)