Obtaining the Task Execution Result List
Function
This API is used to obtain the list of task execution results.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/quality/instances
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain it, see Project ID and Account ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | No | String | Rule name |
| task_type | No | String | Task instance type. Value QUALITY_TASK indicates a quality job and value CONSISTENCY_TASK indicates a comparison job. |
| run_status | No | String | Status. The value can be RUNNING, FAILED, ALARMING, SUCCESS, SUSPENDING, or UNKNOWN. |
| notify_status | No | String | Notification status. The value can be NOT_TRIGGERED, SUCCESS, or FAILED. |
| 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 | Paging offset |
Request 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
| Parameter | Type | Description |
|---|---|---|
| count | Integer | Quantity |
| resources | Array of InstanceOverviewVo objects | Resources |
| Parameter | Type | Description |
|---|---|---|
| id | Long | Job instance ID |
| name | String | Job instance name |
| task_id | Long | task id |
| task_type | String | Job type. Value QUALITY_TASK indicates a quality job and value CONSISTENCY_TASK indicates a comparison job. |
| run_status | String | Job running status. The value can be RUNNING, FAILED, ALARMING, or SUCCESS. |
| notify_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
Status code: 200
Success
{
"count" : 2,
"resources" : [ {
"id" : 1012386207306600400,
"name" : "test-1",
"task_id" : 1012385458115825700,
"task_type" : "QUALITY_TASK",
"run_status" : "SUCCESS",
"notify_status" : "NOT_TRIGGERED",
"start_time" : 1661413281000,
"end_time" : 1661413381000
}, {
"id" : 1012386190504218600,
"name" : "test-0",
"task_id" : 1012386182149165000,
"task_type" : "CONSISTENCY_TASK",
"run_status" : "SUCCESS",
"notify_status" : "NOT_TRIGGERED",
"start_time" : 1661413277000,
"end_time" : 1661413380000
} ]
} 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.
