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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. Execution results of only the tasks that belong to this project can be obtained. |
|
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:
|
|
run_status |
No |
String |
Status. The value can be RUNNING, FAILED, ALARMING, SUCCESS, SUSPENDING, or UNKNOWN. Enumeration values:
|
|
notify_status |
No |
String |
Notification status. The value can be NOT_TRIGGERED, SUCCESS, or FAILED. Enumeration values:
|
|
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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
workspace |
Yes |
String |
Workspace information |
|
X-Auth-Token |
Yes |
String |
token |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
count |
Integer |
Quantity |
|
resources |
Array of InstanceOverviewVo objects |
resources |
|
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
|
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
|
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 |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
