Deze pagina is nog niet beschikbaar in uw eigen taal. We werken er hard aan om meer taalversies toe te voegen. Bedankt voor uw steun.
Obtaining Quality Job Details
Function
This API is used to obtain the details of a quality job.
URI
GET /v2/{project_id}/quality/quality-tasks/{id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Execution results of only the tasks that belong to this project can be obtained. |
id |
Yes |
String |
Quality job ID |
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 |
---|---|---|
id |
Long |
ID |
name |
String |
Job name |
description |
String |
Job description |
category_id |
String |
Catalog ID |
level |
String |
Level. The value can be SUGGEST, MINOR, MAJOR, or FATAL. |
alarm_condition |
String |
Unified alarm condition |
alarm_notify |
Boolean |
Whether to enable alarm notifications |
alarm_notify_type |
String |
Notification type. TRIGGER_ALARM indicates that an alarm is triggered; RUN_SUCCESS indicates that the execution is successful; TRIGGER_ALARM_AND_RUNNING_SUCCESS indicates that an alarm is triggered and the execution is successful. |
alarm_notify_topic |
String |
Notification topic name |
schedule_type |
String |
Scheduling type. The value can be ONCE (one-time scheduling) or PERIODIC (periodic scheduling). |
schedule_start_date |
String |
Scheduling start date |
schedule_end_date |
String |
Scheduling end date |
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. |
schedule_start_time |
String |
Scheduling start time |
schedule_end_time |
String |
Scheduling end time |
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. |
sub_rules |
Array of QualityTaskRuleDetailForOpenApi objects |
Sub-rules |
schedule_cron |
String |
Scheduling cron expression |
Parameter |
Type |
Description |
---|---|---|
id |
Long |
Sub-rule ID |
sub_rule_name |
String |
Sub-rule name |
type |
String |
Rule type. SingleDatabase indicates a database-level rule; SingleTable indicates a table-level rule; SingleColumn indicates a field-level rule; CrossColumn indicates a cross-field rule; Customize indicates a custom rule. |
template_id |
Long |
Rule template ID |
connection |
String |
Data connection ID |
connection_type |
String |
Data connection type |
databases |
String |
Database name. Use commas (,) to separate multiple values. |
sql |
String |
SQL script in a custom rule, which is returned for a system rule |
tables |
String |
Table names. Use commas (,) to separate multiple values. |
reference_tables |
String |
Reference table names in a cross-field rule. Use commas (,) to separate multiple values. |
columns |
String |
Field name. Use commas (,) to separate multiple values. |
reference_columns |
String |
Reference field names in a cross-field rule. Use commas (,) to separate multiple values. |
ignore_error |
String |
Whether to ignore rule errors |
dimension |
String |
Dimension |
queue |
String |
DLI queue |
regular_expression |
String |
Regular expression as the rule template |
template_arguments |
String |
Template parameters |
weight |
Integer |
Rule weight |
calculation_range |
String |
Calculation range |
calculation_range_sql |
String |
Calculation range SQL |
alarm_condition |
String |
Alarm expression |
export_abnormal_table |
Boolean |
Whether to export abnormal data |
abnormal_table_database |
String |
Database where the abnormal table is located |
abnormal_table_schema |
String |
Schema of an abnormal table |
abnormal_table |
String |
Table where the abnormal field is located |
abnormal_table_prefix |
String |
Prefix of an abnormal table |
abnormal_table_suffix |
String |
Suffix of an abnormal table |
abnormal_table_columns |
String |
Name of the abnormal field. Use commas (,) to separate multiple values. |
abnormal_table_sql |
String |
Abnormal table SQL |
abnormal_table_out_config |
String |
Whether the abnormal table outputs rule configuration |
abnormal_table_include_null_value |
String |
Whether the abnormal table contains null values |
abnormal_table_out_data_number |
String |
Number of rows output from the abnormal table. Value 0 indicates that all rows are output. |
score_switch |
String |
Whether to enable quality scoring |
score_schema |
String |
Schema where the quality scoring table is located |
score_table |
String |
Name of the quality scoring table |
score_expression |
String |
Quality scoring expression |
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 |
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.