Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Creating a Data Synchronization Task for a StarRocks Instance
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF

Creating a Data Synchronization Task for a StarRocks Instance

Function

This API is used to create a data synchronization task for a StarRocks instance. Before calling this API:

URI

POST /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.

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

Yes

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

Yes

String

GaussDB(for MySQL) instance ID.

source_node_id

No

String

GaussDB(for MySQL) read replica ID. If this parameter is left blank, the ID of the primary node is used.

source_database

Yes

String

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

target_database

Yes

String

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

task_name

Yes

String

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

ID of the data synchronization task.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

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

{
  "source_instance_id" : "source_instance_id",
  "source_node_id" : "source_node_id",
  "source_database" : "source_database",
  "target_database" : "target_database",
  "task_name" : "task_name"
}

Example Response

Status code: 200

Success.

{
  "job_id" : "123"
}

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)