CreateDataQualityEvaluationTask
创建DataWorks数据质量监控
服务地址:
华东1 金融云
输入参数
只看必填
Target数据质量监控对象
DatabaseType表所属的数据库类型
TableGuid表在数据地图中的唯一ID
PartitionSpec分区表的分区设置
Description质量监控任务描述
Name质量监控任务名称
RuntimeConf扩展配置
Trigger数据质量校验任务的触发配置
Type质量监控触发类型:
TaskIds调度任务Id列表
0调度任务Id
ProjectIdDataWorks工作空间的ID
Hooks回调设置
0Hook
TypeHook类型
ConditionHook触发条件
Notifications通知订阅配置
Condition通知触发条件
Notifications通知设置
0通知设置
NotificationReceivers告警接收人设置
0告警接收人设置
ReceiverType告警接收人类型
Extension告警发送时的额外参数设置
ReceiverValues告警接收人
0接收方取值
NotificationChannels通知方式
0通知方式
Channels通知方式
0告警方式
DataSourceId数据源ID
DataQualityRules数据质量监控关联的数据质量规则列表
0
Name数据质量规则名称
Enabled质量规则是否启用
请选择布尔值
Severity规则对于业务的等级(对应页面上的强弱规则)
Description数据质量规则描述
TemplateCode规则所引用的规则模板唯一标识
SamplingConfig样本采集时
Metric采样的指标名称
MetricParameters样本采集时
SettingConfig具体执行采样语句前
SamplingFilter采样时
CheckingConfig样本校验设置
Type阈值计算方式
ReferencedSamplesFilter有些类型的阈值需要查询出一些参考样本
Thresholds校验阈值设置
Expected期望的阈值设置
Operator比较符
Value阈值数值
Expression阈值表达式
Warned普通警告的阈值设置
Operator比较符
Value阈值数值
Expression阈值表达式
Critical严重警告的阈值设置
Operator比较符
Value阈值数值
Expression阈值表达式
ErrorHandlers质量规则校验问题处理器列表
0质量规则校验问题处理器
Type处理器类型:
ErrorDataFilter如果是自定义SQL规则
Id规则ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

请求参数

字段名称字段详情
Targetobject

数据质量监控对象

Descriptionstring

质量监控任务描述

示例值:OpenAPI create a data quality monitoring test字符长度 <= 65535
Namestring

质量监控任务名称

示例值:OpenAPI create a data quality monitoring test 字符长度 <= 255
RuntimeConfstring

扩展配置,JSON 格式的字符串,只对 EMR 类型的数据质量监控生效。展开详情

示例值:{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Triggerobject

数据质量校验任务的触发配置

ProjectIdinteger<int64>

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10000参考取值来源:
    CreateProject
Hooksarray<object>

回调设置

Notificationsobject

通知订阅配置

DataSourceIdinteger<int64>

数据源 ID,您可以调用 ListDataSources 获取数据源的 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1参考取值来源:
    CreateDataSourceSharedRule
DataQualityRulesarray<object>

数据质量监控关联的数据质量规则列表。如果设置了 DataQualityRule.Id,则把 Id 对应的规则关联到新建质量监控中;如果没有设置,则用其他字段创建一个新的规则,关联到新建的质量监控中。

返回参数

字段名称字段详情
RequestIdstring

Id of the request

示例值:2d9ce-38ef-4923-baf6-391a7e656
Idinteger<int64>

新建的数据质量监控 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:10001
变更历史
暂无变更历史