Obtaining Quality Job Details

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID.

id

Yes

String

Quality job ID

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.

id

Long

Job ID

name

String

Job name

description

String

Job description

category_id

Long

Directory ID

level

String

Alarm severity. SUGGEST indicates warning, MINOR indicates minor, MAJOR indicates major, and FATAL indicates fatal.

alarm_condition

String

Unified alarm condition

alarm_notify

Boolean

Whether to enable alarm notifications

alarm_notify_type

String

Alarm 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 that the execution is successful.

alarm_notify_topic

String

Notification topic name

schedule_type

String

Scheduling type. The value can be ONCE (one-off 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

Last execution time. The value is a 13-digit timestamp accurate to millisecond.

last_run_time

Long

Last execution 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

id

Long

Sub-rule ID

sub_rule_name

String

Sub-rule name

type

String

Rule type. SingleDatabase indicates a database rule, SingleTable indicates a table rule, SingleColumn indicates a field rule, CrossColumn indicates a cross-field rule, and 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 names. 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 names. 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

Boolean

Whether to ignore rule errors

dimension

String

Dimension, which can be Completeness, Uniqueness, Timeliness, Validity, Accuracy, or Consistency

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

Abnormal table schema

abnormal_table

String

Table where abnormal fields are located

abnormal_table_prefix

String

Abnormal table prefix

abnormal_table_suffix

String

Abnormal table suffix

abnormal_table_columns

String

Names of abnormal fields. Use commas (,) to separate multiple values.

abnormal_table_sql

String

Abnormal table SQL

abnormal_table_out_config

Boolean

Whether the abnormal table outputs rule configuration

abnormal_table_include_null_value

Boolean

Whether the abnormal table contains null values

abnormal_table_out_data_number

Integer

Number of rows output from the abnormal table. Value 0 indicates that all rows are output.

score_switch

Boolean

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

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

200

The API call is successful. InstanceVO is returned.

400

BadRequest

500

INTERNAL SERVER ERROR