Melakukan kueri terpaginasi pada daftar instance tugas pemantauan kualitas.
API ini telah ditinggalkan. Kami merekomendasikan migrasi ke dataworks-public(2024-05-18) - ListDataQualityScanRuns guna memperoleh fungsionalitas yang lebih baik dan dukungan berkelanjutan. Meskipun API yang telah ditinggalkan ini masih dapat diakses sementara, tidak akan ada pembaruan atau perbaikan bug lebih lanjut.
Deskripsi operasi
Anda harus membeli DataWorks Basic Edition atau lebih tinggi untuk menggunakan fitur ini.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dataworks:* |
list |
*全部资源
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
Yes |
ID workspace DataWorks. |
100 |
| DataQualityEvaluationTaskId |
integer |
No |
ID tugas evaluasi kualitas data. |
10000 |
| TableGuid |
string |
No |
ID unik tabel di Data Map. |
odps.unit_test.tb_unit_test |
| CreateTimeFrom |
integer |
No |
Waktu mulai paling awal dari instance tugas evaluasi kualitas data. |
1710239005403 |
| CreateTimeTo |
integer |
No |
Waktu mulai paling akhir dari instance tugas evaluasi kualitas data. |
1710239005403 |
| BizdateFrom |
string |
No |
Tanggal mulai bisnis tugas evaluasi kualitas. |
2024-04-01 |
| BizdateTo |
string |
No |
Tanggal akhir bisnis tugas evaluasi kualitas. |
2024-05-01 |
| TriggerClientId |
string |
No |
TriggerClientId di TriggerContext. |
1001 |
| TriggerClient |
string |
No |
TriggerClient di TriggerContext. |
CWF2 |
| PageSize |
integer |
Yes |
Ukuran halaman untuk kueri paginasi daftar. Nilai default: 10. |
10 |
| PageNumber |
integer |
Yes |
Nomor halaman untuk kueri paginasi daftar. Nilai default: 1. |
1 |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Nilai pengembalian. |
||
| RequestId |
string |
ID permintaan API. |
691CA452-D37A-4ED**** |
| PagingInfo |
object |
Hasil kueri paginasi instance tugas evaluasi kualitas. |
|
| PageNumber |
integer |
Nomor halaman. |
1 |
| PageSize |
integer |
Ukuran halaman. |
10 |
| TotalCount |
integer |
Jumlah total catatan. |
294 |
| DataQualityEvaluationTaskInstances |
array<object> |
TaskInstance yang berhasil dipicu. |
|
|
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 |
Contoh
Respons sukses
JSONformat
{
"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"
}
}
]
}
}Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.