Downloading the Object Import Template

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

This API supports only the synchronization scenarios from Oracle to GaussDB Distributed, MySQL to Kafka, and GaussDB(for MySQL) to Kafka.
This API can be used only in certain regions. For details, see Endpoints.

GET /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

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. The default value is application/json.
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

Status code: 400

**Table 4** 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

Obtaining the object import template of the task

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

Status code: 200

The response body is in the file stream format, and the downloaded file is in the ZIP format.

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

Status Code	Description
200	OK
400	Bad Request

For details, see Error Code.

Parent topic: Database Object Configuration

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.