Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Database Object Configuration/ Uploading the Object Import Template
Updated on 2024-05-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Uploading the Object Import Template

Function

This API is used to upload the object import template of a task.

Constraints

  • This API can be used only in certain regions. For details, see Endpoints.
  • Only XLS and XLSX files can be imported for data synchronization from Oracle to GaussDB Distributed. The maximum size of a file is 5 MB. The template can be obtained through the API in Downloading the Object Import Template.
  • Only JSON and TXT files and ZIP packages containing JSON and TXT files can be imported for data synchronization scenarios from GaussDB(for MySQL) to Kafka and from MySQL to Kafka. A ZIP package can contain only one file.
  • Only JSON files can be imported in data synchronization scenarios from GaussDB(for MySQL) to Kafka and from MySQL to Kafka. For details, see Updating object details about a task with a specified ID in the API in Updating Details About a Task with a Specified ID.
  • The maximum size of a JSON or TXT file imported for data synchronization scenarios from GaussDB(for MySQL) to Kafka and from MySQL to Kafka is 5 MB, the maximum size of a ZIP package is 1 MB, and the maximum size of a file in a ZIP package is 20 MB.

URI

POST /v5/{project_id}/jobs/{job_id}/db-object/template

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

file_import_db_level

No

String

The file template supports different levels of data synchronization. If this parameter is left blank, the table level is used by default.

Default value: table

Enumerated values:

  • database
  • table

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. Use the default value multipart/form-data. For APIs used to upload objects or images, the value varies depending on the flow type.

Default value: multipart/form-data

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn
Table 4 FormData parameter

Parameter

Mandatory

Type

Description

file

Yes

File

Template file to be uploaded.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

send_success

Boolean

Whether template upload is complete.

process_status

String

File parsing status.

parsed_success_number

String

Number of rows that are successfully parsed.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 12

Maximum length: 12

error_msg

String

Error message.

Minimum length: 1

Maximum length: 512

Example Request

Uploading the object import template of the task

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/db-object/template

Example Response

Status code: 200

OK

{
  "send_success" : true
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job ID."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.