Obtaining the Comparison Job List
Function
This API is used to obtain the list of comparison jobs.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/quality/consistency-tasks
| 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 |
|---|---|---|---|
| category_id | No | Long | Directory ID |
| name | No | String | Name |
| schedule_status | No | String | Scheduling status, which can be UNKNOWN (the scheduling status is unknown), NOT_START (scheduling has not started), SCHEDULING (the scheduling is in progress), FINISH_SUCCESS (the scheduling is completed properly), KILL (the scheduling is manually stopped), or RUNNING_EXCEPTION (the scheduling fails). |
| 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. |
| creator | No | String | Creator |
| limit | No | Long | Number of records displayed on each page. The maximum value is 100. |
| offset | No | Long | Pagination offset. The minimum value is 0. |
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 | Long | Total number of records |
| resources | Array of QualityTaskOverviewVO_2 objects | Pagination data |
| Parameter | Type | Description |
|---|---|---|
| id | Long | Comparison job ID |
| name | String | Comparison job name |
| category_id | Long | Directory ID |
| schedule_status | String | Scheduling status, which can be UNKNOWN (the scheduling status is unknown), NOT_START (scheduling has not started), SCHEDULING (the scheduling is in progress), FINISH_SUCCESS (the scheduling is completed properly), KILL (the scheduling is manually stopped), or RUNNING_EXCEPTION (the scheduling fails). |
| schedule_period | String | Scheduling period. The value can be MINUTE, HOUR, DAY, or WEEK. |
| schedule_interval | String | Scheduling interval. When the scheduling period is minute, hour, or day, the scheduling interval is a number. When the scheduling period is week, the scheduling interval is days in a week, for example, MONDAY,TUESDAY. |
| create_time | Long | Creation time. The value is a 13-digit timestamp accurate to millisecond. |
| last_run_time | Long | Last running time. The value is a 13-digit timestamp accurate to millisecond. |
| creator | String | Creator |
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
Response. If the operation is successful, InstanceVO is returned.
{
"count" : 1,
"resources" : [ {
"id" : 1012386182149165000,
"name" : "test",
"category_id" : 0,
"schedule_status" : "NOT_START",
"schedule_period" : null,
"schedule_interval" : null,
"create_time" : 1661413275050,
"last_run_time" : null,
"creator" : "ei"
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Response. If the operation is successful, InstanceVO is returned. |
| 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.
