Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Data Synchronization Tasks of a StarRocks Instance
Updated on 2024-09-11 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

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

limit

No

String

Number of records to be queried. Number of data synchronization tasks displayed on each page.

offset

No

String

Index offset. If offset is set to N, the query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number.

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

total_count

String

Total number of data synchronization tasks.

replications

Array of StarRocksReplicationInfo objects

Information about data synchronization tasks.

ext_text

String

Extended field.
Table 5 StarRocksReplicationInfo

Parameter

Type

Description

source_database

String

GaussDB(for MySQL) database. The value can contain 3 to 1024 characters.

target_database

String

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

task_name

String

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

status

String

Current status.

  • Yes: normal
  • No: abnormal

stage

String

Synchronization stage.

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

percentage

String

Progress percentage.

catchup_stage

String

Catchup stage.

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

catchup_percentage

String

Catchup progress percentage.

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)