数据治理中心 DataArts Studio-获取质量作业详情:响应参数

时间:2023-11-01 16:20:39

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

Long

ID

name

String

作业名称

description

String

作业描述

category_id

Long

所属目录ID

level

String

SUGGEST:提示, MINOR:一般, MAJOR:严重, FATAL:致命

alarm_condition

String

统一告警条件

alarm_notify

Boolean

是否开启通知告警

alarm_notify_type

String

TRIGGER_ALARM:触发告警, RUN_SUC CES S:运行成功, TRIGGER_ALARM_AND_RUNNING_SUCCESS:触发告警和运行成功

alarm_notify_topic

String

通知主题名

schedule_type

String

调度类型,ONCE:单次调度,PERIODIC:周期性调度

schedule_start_date

String

调度开始日期

schedule_end_date

String

调度结束日期

schedule_period

String

调度周期,MINUTE:按分钟调度,HOUR:按小时调度,DAY:按天调度,WEEK:按周调度

schedule_interval

String

调度间隔,注意:当调度周期为分钟、小时、天时,间隔时间为数字;而当调度周期为周时,调度间隔为星期的英文,如:每周一、周二调度时,schedule_interval为"MONDAY,TUESDAY"

schedule_start_time

String

调度开始时间

schedule_end_time

String

调度结束时间

create_time

Long

最近运行时间,13位时间戳(精确到毫秒)

last_run_time

Long

最近运行时间,13位时间戳(精确到毫秒)

sub_rules

Array of QualityTaskRuleDetailForOpenApi objects

子规则

schedule_cron

String

调度cron表达式

表4 QualityTaskRuleDetailForOpenApi

参数

参数类型

描述

id

Long

子规则ID

sub_rule_name

String

子规则名称

type

String

SingleDatabase:库级规则,SingleTable:表级规则,SingleColumn:字段级规则,CrossColumn:跨字段规则,Customize:自定义规则

template_id

Long

规则模板ID

connection

String

数据连接ID

connection_type

String

数据连接类型

databases

String

数据库名,当存在多个值时以逗号分隔

sql

String

自定义规则中的SQL脚本,系统内置规则时返回

tables

String

表名,当存在多个值时以逗号分隔

reference_tables

String

跨字段规则中的参考表名,当存在多个值时以逗号分隔

columns

String

字段名,当存在多个值时以逗号分隔

reference_columns

String

跨字段规则中的参考字段名,当存在多个值时以逗号分隔

ignore_error

Boolean

是否忽视规则错误

dimension

String

维度

queue

String

DLI 队列

regular_expression

String

当规则模板为正则表达式校验时的正则表达式

template_arguments

String

模板参数

weight

Integer

规则权重

calculation_range

String

计算范围

calculation_range_sql

String

计算范围SQL

alarm_condition

String

告警表达式

export_abnormal_table

Boolean

是否导出异常数据

abnormal_table_database

String

异常表数据库

abnormal_table_schema

String

异常表Schema

abnormal_table

String

异常字段所在的表

abnormal_table_prefix

String

异常表前缀

abnormal_table_suffix

String

异常表后缀

abnormal_table_columns

String

异常字段名,当存在多个值时以逗号分隔

abnormal_table_sql

String

异常表SQL

abnormal_table_out_config

Boolean

异常表是否输出规则配置

abnormal_table_include_null_value

Boolean

异常表是否包含空值

abnormal_table_out_data_number

Integer

异常表输出行数, 0代表全量输出

score_switch

Boolean

是否开启质量评分

score_schema

String

质量评分表所在schema

score_table

String

质量评分表名

score_expression

String

质量评分表达式

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DQC.0000,请求处理成功

error_msg

String

错误信息

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DQC.0000,请求处理成功

error_msg

String

错误信息

support.huaweicloud.com/api-dataartsstudio/openApiQualityTaskDetail.html