Creates a data quality monitoring run instance.
Operation description
This API operation is available for all DataWorks editions.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Id | long | No | The data quality monitoring run record ID. | 1006059507 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "0bc14115****159376359",
"DataQualityScanRun": {
"Id": 1016440997,
"CreateTime": 1706247622000,
"FinishTime": 1706247622000,
"Status": "Fail",
"Scan": {
"Id": 21077,
"Name": "Hourly partition quality monitoring",
"Description": "This is a hourly run data quality evaluation plan.",
"ProjectId": 164024,
"CreateTime": 1706247622000,
"ModifyTime": 1706247622000,
"CreateUser": 7892346529452,
"ModifyUser": 7892346529452,
"Owner": 7892346529452,
"Spec": {
"datasets": [
{
"type": "Table",
"dataSource": {
"name": "odps_first",
"envType": "Prod"
},
"tables": [
"ods_d_user_info"
],
"filter": "pt = $[yyyymmdd-1]"
}
],
"rules": [
{
"assertion": "row_count > 0"
},
{
"templateId": "SYSTEM:field:null_value:fixed",
"pass": "when = 0",
"name": "The id cannot be empty.",
"severity": "High",
"identity": "a-customized-data-quality-rule-uuid"
}
]
},
"Parameters": [
{
"Value": "$[yyyy-mm-dd-1]",
"Name": "dt"
}
],
"ComputeResource": {
"Name": "emr_cluster_001",
"Runtime": {
"Engine": "Hive",
"SparkConf": {
"test": "test",
"test2": 1
},
"HiveConf": {
"test": "test",
"test2": 1
}
},
"EnvType": "Dev"
},
"RuntimeResource": {
"Id": 60597,
"Cu": 1,
"Image": "i-xxxx"
},
"Trigger": {
"Type": "BySchedule",
"TaskIds": [
1014217266
]
},
"Hooks": [
{
"Condition": "results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }",
"Type": "BlockTaskInstance"
}
]
},
"Parameters": [
{
"Value": "$[yyyy-mm-dd-1]",
"Name": "dt"
}
],
"Results": [
{
"Status": "Fail",
"Details": [
{
"Status": "Fail",
"ReferenceValue": 0,
"CheckValue": 100
}
],
"Sample": {
"value": 100
},
"CreateTime": 1725506795000,
"Rule": {
"templateId": "SYSTEM:field:null_value:fixed",
"pass": "when = 0",
"name": "The id cannot be empty.",
"severity": "High",
"identity": "a-customized-data-quality-rule-uuid"
}
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
