Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Downloading an HTAP Data Synchronization Template
Updated on 2025-10-11 GMT+08:00

Downloading an HTAP Data Synchronization Template

Function

This API is used to download an HTAP data synchronization template. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/htap/template

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

Standard HTAP instance ID, which uniquely identifies an instance.

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 parameter

Parameter

Mandatory

Type

Description

template_type

Yes

String

Definition

Template type.

Constraints

N/A

Range

import_async: Excel file

Default Value

N/A

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 parameter

Parameter

Type

Description

-

File

Definition

HTAP data synchronization template.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/f6df5f5cd3bf447baa8fb0373f8e5992in07/htap/template

Example Response

None

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.