品質監控任務實例列表分頁查詢。
目前該API介面已標記為棄用，推薦使用替代API：dataworks-public(2024-05-18) - ListDataQualityScanRuns。
介面說明
需要購買 DataWorks 基礎版及以上版本才能使用
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dataworks:* |
list |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
是 |
DataWorks 工作空間的 ID |
100 |
| DataQualityEvaluationTaskId |
integer |
否 |
資料品質校驗任務 ID |
10000 |
| TableGuid |
string |
否 |
表在資料地圖中的唯一 ID |
odps.unit_test.tb_unit_test |
| CreateTimeFrom |
integer |
否 |
資料品質校驗任務實例最早開始時間 |
1710239005403 |
| CreateTimeTo |
integer |
否 |
資料品質校驗任務實例最晚開始時間 |
1710239005403 |
| BizdateFrom |
string |
否 |
品質校驗任務業務起始日期 |
2024-04-01 |
| BizdateTo |
string |
否 |
品質校驗任務業務截止日期 |
2024-05-01 |
| TriggerClientId |
string |
否 |
TriggerContext 中的 TriggerClientId |
1001 |
| TriggerClient |
string |
否 |
TriggerContext 中的 TriggerClient |
CWF2 |
| PageSize |
integer |
是 |
列表分頁查詢頁大小，預設為 10 |
10 |
| PageNumber |
integer |
是 |
列表分頁查詢頁碼，預設為 1 |
1 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
傳回值 |
||
| RequestId |
string |
API 請求 ID |
691CA452-D37A-4ED**** |
| PagingInfo |
object |
品質校驗任務實例分頁查詢結果 |
|
| PageNumber |
integer |
頁碼 |
1 |
| PageSize |
integer |
頁大小 |
10 |
| TotalCount |
integer |
總筆數 |
294 |
| DataQualityEvaluationTaskInstances |
array<object> |
被觸發成功的 TaskInstance |
|
|
array<object> |
|||
| Id |
integer |
The ID of the instance. |
10001 |
| CreateTime |
integer |
The time at which the instance was generated. |
1710239005403 |
| FinishTime |
integer |
The time at which the instance finished running. |
1710239005403 |
| Status |
string |
The status of the instance. Valid values:
|
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 |
integer |
The DataWorks workspace ID. |
100 |
| Task |
object |
The snapshot of the configurations for the task when the task starts. |
|
| Id |
integer |
The task ID. |
10001 |
| Description |
string |
The description of the task. |
This is a daily run data quality evaluation plan. |
| ProjectId |
integer |
The workspace ID. |
100 |
| Target |
object |
The monitored object of the task. |
|
| Type |
string |
The type of the monitored object. Valid values:
|
Table |
| DatabaseType |
string |
The type of the database to which the table belongs. Valid values:
|
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 |
| TaskIds |
array |
The IDs of the auto triggered nodes of which the instances are successfully run. |
|
|
integer |
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. |
|
|
object |
|||
| Type |
string |
The type of the callback event. Valid values:
|
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. |
|
|
array<object> |
|||
| NofiticationReceivers |
array<object> |
The alert recipients. |
|
|
object |
|||
| ReceiverType |
string |
The type of the alert recipient. Valid values:
|
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. |
|
|
string |
The alert recipient. |
10000001 |
|
| NotificationChannels |
array<object> |
The alert notification methods. |
|
|
object |
|||
| Channels |
array |
The alert notification methods. |
|
|
string |
|
|
|
| Name |
string |
The name of the monitor. |
Quality verification task |
樣本
正常返回樣本
JSON格式
{
"RequestId": "691CA452-D37A-4ED****",
"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,
"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": "Quality verification task"
}
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。