GetDataQualityEvaluationTask - 查询数据质量监控详情 - 大数据开发治理平台 DataWorks

查询数据质量校验任务详情。

说明

目前该API接口已标记为弃用，推荐使用替代API：dataworks-public(2024-05-18) - CreateDataQualityScan。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Id	integer	否	数据质量监控 ID。	1006455182

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
DataQualityEvaluationTask	object	数据质量监控详情。
Target	object	数据质量监控对象。
Type	string	监控对象类型。 Table：表。	Table
DatabaseType	string	表所属的数据库类型： maxcompute hologres cdh analyticdb_for_mysql starrocks emr analyticdb_for_postgresql	maxcompute
TableGuid	string	表在数据地图中的唯一 ID。	odps.meta_open_api_test_sz.test_partition_tbl
PartitionSpec	string	数据质量监控分区范围设置。	pt=$[yyyymmdd-1]
Description	string	质量监控任务描述。	The description of the quality monitoring task.
Trigger	object	数据质量校验任务的触发配置。
Type	string	质量监控触发类型： ByManual：手动触发 ByScheduledTaskInstance：调度任务触发 ByQualityNode：质量节点触发	ByScheduledTaskInstance
TaskIds	array	调度任务 Id 列表，在 Type 为 ByScheduledTaskInstance 时有效。
	integer	调度任务 Id。	30001
RuntimeConf	string	扩展配置，JSON 格式的字符串，只对 EMR 类型的数据质量监控生效。 queue：执行 EMR 数据质量校验时，使用的 yarn 队列，默认为本项目配置的队列 sqlEngine：执行 EMR 的数据校验时，采用的 SQL 引擎 HIVE_SQL SPARK_SQL	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Id	integer	数据质量监控 ID。	2178
Name	string	质量监控任务名称。	OpenAPI create a data quality monitoring test
ProjectId	integer	项目空间 Id。	2626
Hooks	array<object>	回调设置。
	object	Hook
Type	string	Hook 类型，目前只支持一种： BlockTaskInstance：阻塞调度任务继续运行，数据质量监控是由调度任务触发的，那么在数据质量监控运行完成之后，会根据 Hook.Condition 来判断是否阻塞调度任务继续运行。	BlockTaskInstance
Condition	string	Hook 触发条件，当满足这个条件时，会触发 hook 动作。目前只能支持两种条件表达式：只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有 severity 为 High 的规则校验结果是 Critical，则满足条件指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有 severity 为 High 的规则校验结果是 Critical、或者 severity 为 Normal 的规则校验结果是 Critical、或者 severity 为 Normal 的规则校验结果是 Error，则满足条件，条件表达式中 severity 的枚举与 DataQualityRule 中 severity 的枚举一致、status 的枚举与 DataQualityResult 中的 status 一致。	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	object	通知订阅配置。
Condition	string	通知触发条件，当满足这个条件时，会触发消息通知。目前只能支持两种条件表达式：只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有 severity 为 High 的规则校验结果是 Critical，则满足条件指定多组规则严重类型和规则校验状态，如`(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有 severity 为 High 的规则校验结果是 Critical、或者 severity 为 Normal 的规则校验结果是 Critical、或者 severity 为 Normal 的规则校验结果是 Error，则满足条件，条件表达式中 severity 的枚举与 DataQualityRule 中 severity 的枚举一致、status 的枚举与 DataQualityResult 中的 status 一致。	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	array<object>	通知设置。
	array<object>	通知设置
NotificationReceivers	array<object>	告警接收人设置。
	object	告警接收人设置
ReceiverType	string	告警发送时的额外参数设置，json 格式，支持的 key 如下： atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType 为 DingdingUrl 时生效。枚举值： WebhookUrl : 自定义 webhook 地址 FeishuUrl : 飞书通知地址 DingdingUrl : 钉钉群机器人地址 WeixinUrl : 微信通知地址 AliUid : 用户 ID	DingdingUrl
Extension	string	扩展信息。	{ "atAll": true }
ReceiverValues	array	告警接收人。
	string	接收方取值。当接收方类型为阿里云 ID 时，接收方取值为具体阿里云用户 ID。当接收方类型为 DingdingUrl 时，接收方取值为具体钉钉机器人的告警地址。当接收方类型为 WeixinUrl 时，接收方取值为具体企业微信的告警地址。当接收方类型为 FeishuUrl 时，接收方取值为具体飞书的告警地址。当接收方类型为 WebhookUrl 时，接收方取值为具体自定义 Webhook 的告警地址。	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	通知方式。
	object	通知方式
Channels	array	通知方式。
	string	告警方式 Mail - 邮件 Sms - 短信 Phone - 电话 Feishu - 飞书 Weixin - 微信 Dingding - 钉钉 Webhook - 自定义 Webhook	Mail
DataSourceId	integer	质量监控任务所使用的数据源 ID。	45238

示例

正常返回示例

JSON格式

{
  "RequestId": "SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF",
  "DataQualityEvaluationTask": {
    "Target": {
      "Type": "Table",
      "DatabaseType": "maxcompute",
      "TableGuid": "odps.meta_open_api_test_sz.test_partition_tbl",
      "PartitionSpec": "pt=$[yyyymmdd-1]"
    },
    "Description": "The description of the quality monitoring task.",
    "Trigger": {
      "Type": "ByScheduledTaskInstance",
      "TaskIds": [
        30001
      ]
    },
    "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }\n",
    "Id": 2178,
    "Name": "OpenAPI create a data quality monitoring test",
    "ProjectId": 2626,
    "Hooks": [
      {
        "Type": "BlockTaskInstance",
        "Condition": "(${severity} == \"High\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Error\")"
      }
    ],
    "Notifications": {
      "Condition": "(${severity} == \"High\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Error\")",
      "Notifications": [
        {
          "NotificationReceivers": [
            {
              "ReceiverType": "DingdingUrl",
              "Extension": "{  \"atAll\": true }\n",
              "ReceiverValues": [
                "https://api.fc.aliyuncs.com/webhook\n"
              ]
            }
          ],
          "NotificationChannels": [
            {
              "Channels": [
                "Mail"
              ]
            }
          ]
        }
      ]
    },
    "DataSourceId": 45238
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。