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

Obtaining the Result of Uploading the Object Import Template

Function

This API is used to obtain the result of uploading the object import template of a task.

Constraints

  • 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.

URI

GET /v5/{project_id}/jobs/{job_id}/db-object/template/result

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

type

Yes

String

Type of the uploaded result. Values:

  • detail: Obtain the latest uploaded file and verification result. If the uploaded file contains errors, the error cause is marked in the file.
  • synchronized: Obtain the synchronized (delivered) object file result.
  • change: Obtain the results of added and deleted objects (used in task editing).

Enumerated values:

  • detail
  • synchronized
  • change

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

Response Parameters

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

Example Request

Querying the result of uploading object import template of the task

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

Example Response

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.10030008",
  "error_msg": "Failed to download the file"
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.