Query the details of a data quality validation task.
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
Test
RAM authorization
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 |
| DatabaseType |
string |
Database type to which the table belongs:
|
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:
|
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": "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 |
| Condition |
string |
Hook trigger condition. When this condition is met, the hook action is triggered. Currently, only two types of conditional expressions are supported:
|
(${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:
|
(${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:
Valid values:
|
DingdingUrl |
| Extension |
string |
Extended information. |
{ "atAll": true } |
| ReceiverValues |
array |
Alert receiver. |
|
|
string |
Receiver value.
|
https://api.fc.aliyuncs.com/webhook |
|
| NotificationChannels |
array<object> |
Notification method. |
|
|
object |
Notification method |
||
| Channels |
array |
Notification method. |
|
|
string |
Alert method
|
|
|
| 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.