ListDataQualityEvaluationTaskInstances - DataWorks - Alibaba Cloud Documentation Center

Queries a list of instances generated by a data quality monitoring task by page.

Operation description

This API operation is available for all DataWorks editions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The DataWorks workspace ID.	100
DataQualityEvaluationTaskId	long	No	The ID of the data quality monitoring task.	10000
TableGuid	string	No	The ID of the table in Data Map.	odps.unit_test.tb_unit_test
CreateTimeFrom	long	No	The earliest start time at which the instances are generated.	1710239005403
CreateTimeTo	long	No	The latest start time at which the instances are generated.	1710239005403
BizdateFrom	string	No	The start time of the data quality monitoring task.	2024-04-01
BizdateTo	string	No	The end time of the data quality monitoring task.	2024-05-01
TriggerClientId	string	No	The ID of the instance that is generated by the task.	1001
TriggerClient	string	No	The name of the trigger module of the instance.	CWF2
PageSize	integer	No	The number of entries per page. Default value: 10.	10
PageNumber	integer	No	The page number. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	691CA452-D37A-4ED0-9441
PagingInfo	object	The pagination information.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	294
DataQualityEvaluationTaskInstances	array<object>	The instances generated by the task.
DataQualityEvaluationTaskInstance	object
Id	long	The ID of the instance.	10001
CreateTime	long	The time at which the instance was generated.	1710239005403
FinishTime	long	The time at which the instance finished running.	1710239005403
Status	string	The status of the instance. Valid values: Running Error Passed Warned Critical	Critical
Parameters	string	The parameters configured for the instance.	{ "bizdate": "20240517", "triggerTime": "1710239005403" }
TriggerContext	string	The information about the trigger module of the instance.	{ "TriggerClientId": 10001, "TriggerClient": "CWF2" }
ProjectId	long	The DataWorks workspace ID.	100
Task	object	The snapshot of the configurations for the task when the task starts.
Id	long	The task ID.	10001
RegionId	string	The region ID.	cn-shanghai
Description	string	The description of the task.	This is a daily run data quality evaluation plan.
ProjectId	long	The workspace ID.	100
Target	object	The monitored object of the task.
Type	string	The type of the monitored object. Valid values: Table	Table
DatabaseType	string	The type of the database to which the table belongs. Valid values: maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	The ID of the table in Data Map.	odps.unit_test.tb_unit_test
PartitionSpec	string	The configuration of the partitioned table.	ds=$[yyyymmdd-1]
Trigger	object	The trigger configuration of the task.
Type	string	The trigger condition of the task. Valid values: ByScheduledTaskInstance. The value indicates that the task is triggered when the instance of an auto triggered node is successfully run.	ByScheduledTaskInstance
TaskIds	array	The IDs of the auto triggered nodes of which the instances are successfully run.
TaskId	long	The ID of the auto triggered node.	10000
RuntimeConf	string	The configuration of the data source. The value of the queue field is default, and that of the sqlEngine field can be set to SPARK_SQL, KYUUBI, PRESTO_SQL, or HIVE_SQL. The value default indicates the YARN queue for E-MapReduce (EMR) tasks.	{ "queue": "default", "sqlEngine": "SPARK-SQL" }
Hooks	array<object>	The callback configurations of the task during the instance lifecycle. Blocking an auto triggered node is a type of callback event. Only this type is supported.
Hook	object
Type	string	The type of the callback event. Valid values: BlockTaskInstance. The value indicates that an auto triggered node is blocked.	BlockTaskInstance
Condition	string	The trigger configuration of the callback event.	${severity} == "High" AND ${status} == "Critical"
Notifications	object	The configurations for alert notifications.
Condition	string	The trigger condition of the alert notification.	${severity} == "High"
Notifications	array<object>	The configurations for the alert notification.
Notifications	object
NofiticationReceivers	array<object>	The alert recipients.
NotificationReceiver	object
ReceiverType	string	The type of the alert recipient. Valid values: AliUid: Alibaba Cloud account ID WebhookUrl: URL of a custom webhook DingdingUrl: DingTalk chatbot URL FeishuUrl: Lark chatbot URL WeixinUrl: WeCom chatbot URL	AliUid
Extension	string	The extended information in the JSON format. For example, the DingTalk chatbot can remind all members in a DingTalk group by using the at sign (@).	{"atAll":"true"}
ReceiverValues	array	The alert recipients.
ReceiverValue	string	The alert recipient.	10000001
NotificationChannels	array<object>	The alert notification methods.
NotificationChannel	object
Channels	array	The alert notification methods.
Channel	string	Mail Sms Phone Feishu Weixin: WeCom notification Dingding Webhook	Mail
Name	string	The name of the task.

Examples

Sample success responses

JSONformat

{
  "RequestId": "691CA452-D37A-4ED0-9441",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 294,
    "DataQualityEvaluationTaskInstances": [
      {
        "Id": 10001,
        "CreateTime": 1710239005403,
        "FinishTime": 1710239005403,
        "Status": "Critical",
        "Parameters": "{\n  \"bizdate\": \"20240517\",\n  \"triggerTime\": \"1710239005403\"\n}",
        "TriggerContext": "{\n  \"TriggerClientId\": 10001,\n  \"TriggerClient\": \"CWF2\"\n}",
        "ProjectId": 100,
        "Task": {
          "Id": 10001,
          "RegionId": "cn-shanghai",
          "Description": "This is a daily run data quality evaluation plan.",
          "ProjectId": 100,
          "Target": {
            "Type": "Table",
            "DatabaseType": "maxcompute",
            "TableGuid": "odps.unit_test.tb_unit_test",
            "PartitionSpec": "ds=$[yyyymmdd-1]"
          },
          "Trigger": {
            "Type": "ByScheduledTaskInstance",
            "TaskIds": [
              10000
            ]
          },
          "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK-SQL\" }",
          "Hooks": [
            {
              "Type": "BlockTaskInstance",
              "Condition": "${severity} == \"High\" AND ${status} == \"Critical\""
            }
          ],
          "Notifications": {
            "Condition": "${severity} == \"High\"",
            "Notifications": [
              {
                "NofiticationReceivers": [
                  {
                    "ReceiverType": "AliUid",
                    "Extension": "{\"atAll\":\"true\"}",
                    "ReceiverValues": [
                      "10000001"
                    ]
                  }
                ],
                "NotificationChannels": [
                  {
                    "Channels": [
                      "Mail"
                    ]
                  }
                ]
              }
            ]
          },
          "Name": ""
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-12-19	The response structure of the API has changed	View Change Details
2024-11-06	The response structure of the API has changed	View Change Details