Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Lightweight Edition)/ Creating a Data Synchronization Task
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Data Synchronization Task

Function

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

URI

POST /v3/{project_id}/instances/{instance_id}/clickhouse/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

ClickHouse 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

No

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

Source instance ID.

source_node_id

No

String

Source node ID. 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.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

ID of the created 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

Creating a data synchronization task for a ClickHouse instance

POST https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication

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

Example Response

Status code: 200

Success.

{
  "job_id" : "18ef8ee3-b880-4851-8978-bb6acbd4e695"
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.