GetDataQualityEvaluationTaskInstance - 获取数据质量校验任务实例详情 - 大数据开发治理平台 DataWorks

获取数据质量校验任务实例详情。

说明

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

接口说明

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

调试

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

调试

授权信息

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

请求参数

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

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。用于定位日志，排查问题。	8abcb91f-d266-4073-b907-2ed67****
DataQualityEvaluationTaskInstance	object	数据质量监控实例详情。
Status	string	数据质量监控实例状态。 Running：校验中 Error：有规则校验出错 Passed：所有规则校验通过 Warned：有规则触发普通告警阈值 Critical：有规则触发严重告警阈值	Passed
Task	object	数据质量监控。
Name	string	数据质量监控名称。	Data quality OpenAPI monitoring test
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"
Notifications	array<object>	告警方式。
	array<object>
NotificationReceivers	array<object>	接收方取值。
	object
ReceiverType	string	告警接收人类型。	DingdingUrl
Extension	string	告警发送时的额外参数设置，json 格式，支持的 key 如下： atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType 为 DingdingUrl 时生效。	{ "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
Hooks	array<object>	回调设置。
	object
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")
RuntimeConf	string	扩展配置，JSON 格式的字符串，只对 EMR 类型的数据质量监控生效。 queue：执行 EMR 数据质量校验时，使用的 yarn 队列，默认为本项目配置的队列 sqlEngine：执行 EMR 的数据校验时，采用的 SQL 引擎 HIVE_SQL SPARK_SQL	{ "queue": "default" }
Trigger	object	数据质量校验任务的触发配置。
Type	string	质量监控触发类型： ByManual：手动触发，默认值 ByScheduledTaskInstance：关联调度任务触发	ByScheduledTaskInstance
TaskIds	array	调度任务 Id 列表，在 Type 为 ByScheduledTaskInstance 时有效。
	integer	调度任务 Id。	70006236752324
Target	object	参看 DataQualityTarget 示例，数据质量校验任务的监控对象，参考 DataQualityTarget。
Type	string	监控对象类型。 Table：表	Table
DatabaseType	string	表所属的数据库类型。	maxcompute
TableGuid	string	表在数据地图中的唯一 ID。	odps.api_trace.ods_d_api_log
PartitionSpec	string	监控的分区范围。	pt=$[yyyymmdd-1]
Description	string	数据质量监控的描述信息。	OpenAPI quality monitoring test
Id	integer	数据质量监控 ID。	28544990
ProjectId	integer	工作空间的 ID。	20629
Parameters	string	数据质量校验执行参数，JSON 格式，可用的 key 如下： triggerTime：触发时间的毫秒时间戳，数据质量监控的数据范围中$[yyyymmdd]表达式的基准时间，必填。	{ "triggerTime": 1733284062000 }
FinishTime	integer	实例运行的结束时间。	1716344665000
TriggerContext	string	实例触发时的上下文信息，JSON 格式。可能包含的 key 如下： TriggerClient：数据质量监控实例的触发来源，常见的如 CWF2（调度系统）等，后续有可能会新增。 TriggerClientId：关联到来源系统中某个具体的业务资源。比如 TriggerClient 为 CWF2 时，这里记录调度任务 ID。	{ "triggerClient": "CWF2", "triggerClientId": 70001238945 }
CreateTime	integer	创建时间。	1716344665000
Id	integer	数据质量监控实例 ID。	7234231689
ProjectId	integer	工作空间的 ID。	98330
Results	array<object>
	array<object>
Id	integer
Status	string
CreateTime	integer
TaskInstanceId	integer
Sample	string
Details	array<object>
	object
ReferencedValue	string
CheckedValue	string
Status	string
Rule	object
Id	integer
Name	string
ProjectId	integer
Enabled	boolean
Severity	string
Description	string
TemplateCode	string
Target	object
Type	string
DatabaseType	string
TableGuid	string
SamplingConfig	object
Metric	string
MetricParameters	string
SettingConfig	string
SamplingFilter	string
CheckingConfig	object
Type	string
ReferencedSamplesFilter	string
Thresholds	object
Expected	object
Value	string
Operator	string
Expression	string
Warned	object
Value	string
Operator	string
Expression	string
Critical	object
Value	string
Operator	string
Expression	string
ErrorHandlers	array<object>
	object
Type	string
ErrorDataFilter	string

示例

正常返回示例

JSON格式

{
  "RequestId": "8abcb91f-d266-4073-b907-2ed67****",
  "DataQualityEvaluationTaskInstance": {
    "Status": "Passed",
    "Task": {
      "Name": "Data quality OpenAPI monitoring test\n",
      "Notifications": {
        "Condition": "${severity} == \"High\" AND ${status} == \"Critical\"",
        "Notifications": [
          {
            "NotificationReceivers": [
              {
                "ReceiverType": "DingdingUrl",
                "Extension": "{ \"atAll\": true }",
                "ReceiverValues": [
                  "https://api.fc.aliyuncs.com/webhook"
                ]
              }
            ],
            "NotificationChannels": [
              {
                "Channels": [
                  "Mail"
                ]
              }
            ]
          }
        ]
      },
      "Hooks": [
        {
          "Type": "BlockTaskInstance",
          "Condition": "(${severity} == \"High\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Error\")"
        }
      ],
      "RuntimeConf": "{ \"queue\": \"default\" }",
      "Trigger": {
        "Type": "ByScheduledTaskInstance",
        "TaskIds": [
          70006236752324
        ]
      },
      "Target": {
        "Type": "Table",
        "DatabaseType": "maxcompute",
        "TableGuid": "odps.api_trace.ods_d_api_log",
        "PartitionSpec": "pt=$[yyyymmdd-1]"
      },
      "Description": "OpenAPI quality monitoring test",
      "Id": 28544990,
      "ProjectId": 20629
    },
    "Parameters": "{ \"triggerTime\": 1733284062000 }\n",
    "FinishTime": 1716344665000,
    "TriggerContext": "{ \"triggerClient\": \"CWF2\", \"triggerClientId\": 70001238945 }",
    "CreateTime": 1716344665000,
    "Id": 7234231689,
    "ProjectId": 98330,
    "Results": [
      {
        "Id": 0,
        "Status": "",
        "CreateTime": 0,
        "TaskInstanceId": 0,
        "Sample": "",
        "Details": [
          {
            "ReferencedValue": "",
            "CheckedValue": "",
            "Status": ""
          }
        ],
        "Rule": {
          "Id": 0,
          "Name": "",
          "ProjectId": 0,
          "Enabled": true,
          "Severity": "",
          "Description": "",
          "TemplateCode": "",
          "Target": {
            "Type": "",
            "DatabaseType": "",
            "TableGuid": ""
          },
          "SamplingConfig": {
            "Metric": "",
            "MetricParameters": "",
            "SettingConfig": "",
            "SamplingFilter": ""
          },
          "CheckingConfig": {
            "Type": "",
            "ReferencedSamplesFilter": "",
            "Thresholds": {
              "Expected": {
                "Value": "",
                "Operator": "",
                "Expression": ""
              },
              "Warned": {
                "Value": "",
                "Operator": "",
                "Expression": ""
              },
              "Critical": {
                "Value": "",
                "Operator": "",
                "Expression": ""
              }
            }
          },
          "ErrorHandlers": [
            {
              "Type": "",
              "ErrorDataFilter": ""
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

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