Help Center/ DataArts Studio/ API Reference/ DataArts Quality APIs/ Import/Export/ Obtaining the Status of an Import/Export Task
Updated on 2024-11-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Status of an Import/Export Task

Function

This API is used to obtain the progress of an export or import task.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/quality/resource/status/{resource_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

resource_id

Yes

String

ID of the resource export/import task. It can be obtained from the return of the API for exporting resources or importing resources.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

DataArts Studio workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Auth-Token

Yes

String

IAM token. For details about how to obtain the token, see Authentication.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Record ID

resource_id

String

ID of the resource export or import task

resource_type

String

Resource type

action

String

Operation type. EXPORT indicates export, and REPORT indicates import.

file_name

String

Resource file name

start_time

String

Start time

end_time

String

End time

status

String

Task status. WAITING indicates that the task is waiting to be executed, RUNNING indicates that the task is being executed, TIMEOUT indicates that the task times out, FAILED indicates that the task fails, and SUCCESS indicates that the task is executed successfully.

error_msg

String

Error message

project_id

String

Project ID

domain_id

String

User ID

user_name

String

Username

export_resources

String

Resources to be exported. This parameter is left blank by default.

import_body

String

Import body. This parameter is left blank by default.

file_status

String

File status. PREPARING indicates that the file is being prepared. GENERATED indicates that the file is ready. DELETED indicates that the file has been deleted. FAILED indicates that the file fails to be uploaded or generated.

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Success

500

INTERNAL SERVER ERROR
Parent Topic: Import/Export