Help Center> DataArts Studio> API Reference> DataArts Quality APIs> O&M APIs> Obtaining the Task Execution Result List
Updated on 2022-09-15 GMT+08:00

Obtaining the Task Execution Result List

Function

This API is used to obtain the list of task execution results.

URI

GET /v2/{project_id}/quality/instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. Execution results of only the tasks that belong to this project can be obtained.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Rule name

task_type

No

String

Task instance type. The value can be QUALITY_TASK (quality job) or CONSISTENCY_TASK (comparison job).

Enumeration values:

  • QUALITY_TASK

  • CONSISTENCY_TASK

run_status

No

String

Status. The value can be RUNNING, FAILED, ALARMING, SUCCESS, SUSPENDING, or UNKNOWN.

Enumeration values:

  • SUCCESS

  • FAILED

  • RUNNING

  • ALARMING

notify_status

No

String

Notification status. The value can be NOT_TRIGGERED, SUCCESS, or FAILED.

Enumeration values:

  • SUCCESS

  • FAILED

  • NOT_TRIGGERED

start_time

No

Long

Start time of the last query period. The value is a 13-digit timestamp accurate to millisecond.

end_time

No

Long

End time of the last query period. The value is a 13-digit timestamp accurate to millisecond.

limit

No

Integer

Number of records displayed on each page. The maximum value is 100.

offset

No

Integer

Pagination offset

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

Workspace information

X-Auth-Token

Yes

String

token

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Quantity

resources

Array of InstanceOverviewVo objects

resources

Table 5 InstanceOverviewVo

Parameter

Type

Description

id

Long

id

name

String

Name

task_id

Long

task id

task_type

String

Task type. The value can be QUALITY_TASK (quality job) or CONSISTENCY_TASK (comparison job).

run_status

String

Running status. The value can be RUNNING, FAILED, ALARMING, or SUCCESS.

notity_status

String

Notification status. The value can be NOT_TRIGGERED, SUCCESS, or FAILED.

start_time

Long

Start time

end_time

Long

End time

Status code: 400

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

Status code: 500

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

400

BadRequest

500

INTERNAL SERVER ERROR