All Products
Search
Document Center

DataWorks:GetDataQualityEvaluationTask

Last Updated:Sep 29, 2026

Query the details of a data quality validation task.

Note

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

Operation description

Available only with DataWorks Basic Edition or higher.

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

No

Data quality monitoring ID.

1006455182

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF

DataQualityEvaluationTask

object

Data quality monitoring details.

Target

object

Data quality monitoring object.

Type

string

Monitoring object type.

  • Table: Table.

Table

DatabaseType

string

Database type to which the table belongs:

  • maxcompute

  • hologres

  • cdh

  • analyticdb_for_mysql

  • starrocks

  • emr

  • analyticdb_for_postgresql

maxcompute

TableGuid

string

Unique ID of the table in Data Map.

odps.meta_open_api_test_sz.test_partition_tbl

PartitionSpec

string

Partition range setting for data quality monitoring.

pt=$[yyyymmdd-1]

Description

string

Description of the quality monitoring task.

The description of the quality monitoring task.

Trigger

object

Trigger configuration of the data quality validation task.

Type

string

Quality monitoring trigger type:

  • ByManual: Manual trigger

  • ByScheduledTaskInstance: Scheduled task trigger

  • ByQualityNode: Quality node trigger

ByScheduledTaskInstance

TaskIds

array

List of scheduled task IDs. Valid when Type is ByScheduledTaskInstance.

integer

Scheduled task ID.

30001

RuntimeConf

string

Extended configuration. A JSON-formatted string. Only takes effect for EMR-type data quality monitoring.

  • queue: The YARN queue used when executing EMR data quality validation. Defaults to the queue configured for the current project.

  • sqlEngine: The SQL engine used when executing EMR data validation.
    • HIVE_SQL

    • SPARK_SQL

{ "queue": "default", "sqlEngine": "SPARK_SQL" }

Id

integer

Data quality monitoring ID.

2178

Name

string

Name of the quality monitoring task.

OpenAPI create a data quality monitoring test

ProjectId

integer

Workspace ID.

2626

Hooks

array<object>

Callback settings.

object

Hook

Type

string

Hook type. Currently, only one type is supported:

  • BlockTaskInstance: Blocks the scheduled task from continuing to run. When data quality monitoring is triggered by a scheduled task, after the data quality monitoring completes, Hook.Condition is used to determine whether to block the scheduled task from continuing to run.

BlockTaskInstance

Condition

string

Hook trigger condition. When this condition is met, the hook action is triggered. Currently, only two types of conditional expressions are supported:

  • Specify a single group of rule severity type and rule validation status, e.g., ${severity} == "High" AND ${status} == "Critical", which means the condition is met if any executed rule with severity High has a validation result of Critical.

  • Specify multiple groups of rule severity types and rule validation statuses, e.g., (${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error"), which means the condition is met if any executed rule has severity High with validation result Critical, or severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the conditional expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.

(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")

Notifications

object

Notification subscription configuration.

Condition

string

Notification trigger condition. When this condition is met, the message notification is triggered. Currently, only two types of conditional expressions are supported:

  • Specify a single group of rule severity type and rule validation status, e.g., ${severity} == "High" AND ${status} == "Critical", which means the condition is met if any executed rule with severity High has a validation result of Critical.

  • Specify multiple groups of rule severity types and rule validation statuses, e.g., (${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error"), which means the condition is met if any executed rule has severity High with validation result Critical, or severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the conditional expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.

(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")

Notifications

array<object>

Notification settings.

array<object>

Notification settings

NotificationReceivers

array<object>

Alert receiver settings.

object

Alert receiver settings

ReceiverType

string

Additional parameter settings when sending alerts. JSON format. Supported keys are as follows:

  • atAll: Whether to @everyone in the group when sending DingTalk alerts. Takes effect when ReceiverType is DingdingUrl.

Valid values:

  • WebhookUrl :

    Custom webhook URL

  • FeishuUrl :

    Lark notification URL

  • DingdingUrl :

    DingTalk group robot URL

  • WeixinUrl :

    WeCom notification URL

  • AliUid :

    User ID

DingdingUrl

Extension

string

Extended information.

{ "atAll": true }

ReceiverValues

array

Alert receiver.

string

Receiver value.

  • 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 specific alert URL of the DingTalk robot.

  • When the receiver type is WeixinUrl, the receiver value is the specific alert URL of WeCom.

  • When the receiver type is FeishuUrl, the receiver value is the specific alert URL of Lark.

  • When the receiver type is WebhookUrl, the receiver value is the specific alert URL of the custom Webhook.

https://api.fc.aliyuncs.com/webhook

NotificationChannels

array<object>

Notification method.

object

Notification method

Channels

array

Notification method.

string

Alert method

  • Mail - Email

  • Sms - SMS

  • Phone - Phone

  • Feishu - Lark

  • Weixin - WeCom

  • Dingding - DingTalk

  • Webhook - Custom Webhook

Mail

DataSourceId

integer

Data source ID used by the quality monitoring task.

45238

Examples

Success response

JSON format

{
  "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
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.