GetDataQualityEvaluationTaskInstance - DataWorks - Alibaba Cloud Documentation Center

Retrieves the details of a data quality check task instance.

Note

This API has been deprecated. We recommend migrating to dataworks-public(2024-05-18) - GetDataQualityScanRun for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Operation description

DataWorks Basic Edition or a higher edition is required to use this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The instance ID of the data quality monitoring task.	7227550902

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. Used to locate logs and troubleshoot issues.	8abcb91f-d266-4073-b907-2ed67****
DataQualityEvaluationTaskInstance	object	The details of the data quality monitoring instance.
Status	string	The instance status of the data quality monitoring task. Valid values: Running: The check is in progress. Error: A rule check encountered an error. Passed: All rule checks passed. Warned: A rule triggered a normal alert threshold. Critical: A rule triggered a critical alert threshold.	Passed
Task	object	The data quality monitoring task.
Name	string	The name of the monitor.	Data quality OpenAPI monitoring test
Notifications	object	The configurations of alert notifications.
Condition	string	The notification trigger condition. When this condition is met, the alert notification is triggered. Only two conditional expressions are supported: Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical. Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.	${severity} == "High" AND ${status} == "Critical"
Notifications	array<object>	The alert notification methods.
	array<object>
NotificationReceivers	array<object>	The value of the receiver.
	object
ReceiverType	string	The type of alert recipient.	DingdingUrl
Extension	string	Additional parameter settings for sending alerts in json format. The supported keys are as follows: atAll: when sending DingTalk alerts, do you need to @ everyone in the group. It takes effect when ReceiverType is DingdingUrl.	{ "atAll": true }
ReceiverValues	array	The recipient of the alert.
	string	The value of the receiver. When the receiver type is Alibaba Cloud ID, the receiver value is the specific Alibaba cloud user ID. When the receiver type is DingdingUrl, the receiver value is the alert address of the specific DingTalk robot. When the receiver type is WeixinUrl, the receiver value is the alert address of the specific Enterprise WeChat. When the receiver type is FeishuUrl, the receiver value is the alert address of the specific flying book. When the receiver type is WebhookUrl, the receiver value is the alert address of the specific custom Webhook.	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	The notification method.
	object
Channels	array	The notification method.
	string	Alarm mode Mail: Mail Sms: Sms Phone: Phone Feishu: flying book Weixin: WeChat Dingding: DingTalk Webhook: custom Webhook	Mail
Hooks	array<object>	The hook.
	object
Type	string	Hook type. Currently, only one type is supported: BlockTaskInstance: the blocking scheduling task continues to run. Data quality monitoring is triggered by the scheduling task. After the data quality monitoring is completed, the Hook.Condition is used to determine whether the blocking scheduling task continues to run.	BlockTaskInstance
Condition	string	The hook trigger condition. When this condition is met, the hook action is triggered. Only two conditional expressions are supported: Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical. Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
RuntimeConf	string	Extended configuration, JSON-formatted string, takes effect only for EMR-type data quality monitoring. queue: the yarn queue used when performing EMR data quality verification. The default queue is the queue configured for this project. sqlEngine: SQL engine used when performing EMR data verification HIVE_ SQL SPARK_ SQL	{ "queue": "default" }
Trigger	object	The trigger configuration of the monitor.
Type	string	The trigger type of the monitor. Valid values: ByManual (default): The monitor is manually triggered. ByScheduledTaskInstance: The monitor is triggered by the associated scheduling tasks.	ByScheduledTaskInstance
TaskIds	array	The Id list of the scheduled task, which is valid when the Type is ByScheduledTaskInstance.
	integer	The Id of the scheduled task.	70006236752324
Target	object	The monitored object of the monitor.
Type	string	The type of the monitoring object. Table: Table	Table
DatabaseType	string	The type of the database to which the table belongs.	maxcompute
TableGuid	string	The unique ID of the table in the data map.	odps.api_trace.ods_d_api_log
PartitionSpec	string	The partition range monitored.	pt=$[yyyymmdd-1]
Description	string	The description of the monitor.	OpenAPI quality monitoring test
Id	integer	The ID of the data quality monitor.	28544990
ProjectId	integer	The ID of the workspace.	20629
Parameters	string	The execution parameters for the data quality check, in JSON format. The following keys are available: triggerTime: the millisecond-level timestamp of the trigger time. This is the base time for the $[yyyymmdd] expression in the data range of the data quality monitoring task. This key is required.	{ "triggerTime": 1733284062000 }
FinishTime	integer	The end time of the instance execution.	1716344665000
TriggerContext	string	The context information when the instance is triggered, in JSON format. The following keys may be included: TriggerClient: the trigger source of the data quality monitoring instance, such as CWF2 (scheduling system). More values may be added in the future. TriggerClientId: the ID of a specific business resource in the source system. For example, when TriggerClient is CWF2, this field records the scheduling task ID.	{ "triggerClient": "CWF2", "triggerClientId": 70001238945 }
CreateTime	integer	The creation time.	1716344665000
Id	integer	The data quality monitoring instance ID.	7234231689
ProjectId	integer	The workspace 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

Examples

Success response

JSON format

{
  "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": false,
          "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": ""
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.