Obtaining the Quality Job List

Function

This API is used to obtain the list of quality jobs.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/quality/rules

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
start	No	Long	Start page number, which is used to calculate the pagination query offset. If neither offset nor limit is empty, the value of offset is used.
page_size	No	Long	Number of records displayed on each page. If neither offset nor limit is empty, the value of limit is used.
offset	No	Integer	Pagination query offset
limit	No	Integer	Number of records displayed on each page
category_id	No	Long	Directory ID
rule_name	No	String	Quality job name
schedule_status	No	Integer	Scheduling status. Value 1 indicates that the scheduling has not started, 2 indicates that the scheduling is in progress, 3 indicates that the scheduling is completed properly, 4 indicates that the scheduling is manually stopped, and 5 indicates that the scheduling is abnormal.
schedule_period	No	Integer	Scheduling period. Value 1 indicates minute, 2 indicates hour, 3 indicates day, 4 indicates week, and 5 indicates month.
start_time	No	String	Start time (search), in yyyy-MM-dd HH:mm:ss format
end_time	No	String	End time (search), in yyyy-MM-dd HH:mm:ss format
result_status	No	Integer	Last execution result. The value can be 0 (running), 1 (abnormal), 2 (alarming), or 3 (normal).
sort	No	String	Sorting field
order	No	String	Sorting order

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** 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
data	Object	Returned data

Status code: 400

**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
data	Object	Returned data

Status code: 401

**Table 5** 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
data	Object	Returned data

Status code: 403

**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
data	Object	Returned data

Example Requests

None

Example Responses

Status code: 200

The operation succeeds. Data is returned.

{
  "data" : {
    "num" : 100,
    "page_search_result" : [ {
      "id" : "1042745498940891137",
      "name" : "rule-name",
      "creator" : "test-user",
      "create_offset_time" : "2022-11-17T10:23:12+08:00",
      "modify_offset_time" : "2022-11-17T10:23:46+08:00",
      "dw_name" : "",
      "db_name" : "",
      "schedule_status" : 1,
      "calc_offset_time" : "2022-11-17T10:51:59+08:00"
    } ]
  }
}