ListDataQualityEvaluationTasks - DataWorks - Alibaba Cloud Documentation Center

Mengkueri daftar node pemantauan kualitas dengan paginasi.

Catatan

API ini telah ditinggalkan. Kami merekomendasikan migrasi ke dataworks-public(2024-05-18) - ListDataQualityScans 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 Edisi Dasar atau edisi yang lebih tinggi untuk menggunakan fitur ini.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

list

*Semua Sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID ruang kerja DataWorks.	100
TableGuid	string	No	ID unik tabel di Peta Data DataWorks.	odps.unit_test.tb_unit_test
Name	string	No	Nama yang digunakan untuk pencocokan fuzzy nama tugas evaluasi kualitas data.	Test
PageSize	integer	Yes	Ukuran halaman untuk paginasi. Nilai default: 10.	10
PageNumber	integer	Yes	Nomor halaman untuk paginasi. Nilai default: 1.	1

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan API, yang digunakan untuk melacak panggilan lengkap. Anda dapat menggunakan string ini untuk memecahkan masalah.	691CA452-D37A-4ED0-****
PagingInfo	object	Hasil kueri berhalaman dari node evaluasi kualitas.
TotalCount	string	Jumlah total rekaman.	131
PageSize	string	Ukuran halaman.	10
PageNumber	string	Nomor halaman.	1
DataQualityEvaluationTasks	array<object>	Tugas evaluasi kualitas.
	array<object>
Id	integer	ID tugas evaluasi kualitas data.	10001
Name	string	Nama tugas evaluasi kualitas data. Nama dapat berisi angka, huruf, karakter Tionghoa, dan tanda baca lebar setengah atau penuh. Panjang nama maksimal 255 karakter.	Tugas verifikasi kualitas data
Description	string	Deskripsi tugas evaluasi kualitas data. Panjang deskripsi maksimal 65.535 karakter.	Ini adalah rencana evaluasi kualitas data yang dijalankan harian
ProjectId	integer	ID ruang kerja DataWorks.	100
Target	object	Objek yang dipantau dari tugas evaluasi kualitas data.
Type	string	Tipe objek yang dipantau. Nilai valid: Table	Table
DatabaseType	string	Tipe database dari set data tabel. Nilai valid: maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	ID unik tabel di Peta Data DataWorks.	odps.unit_test.tb_unit_test
PartitionSpec	string	Pengaturan partisi dari tabel partisi.	ds=$[yyyymmdd-1]
Trigger	object	Konfigurasi pemicu tugas evaluasi kualitas data.
Type	string	Tipe event yang memicu tugas evaluasi kualitas. Nilai valid: ByScheduledTaskInstance: Dipicu ketika Instans node penjadwalan berhasil dijalankan.	ByScheduledTaskInstance
TaskIds	array	Parameter ini berlaku ketika type diatur ke ByScheduledTaskInstance. Menentukan ID node penjadwalan yang eksekusi Instansnya yang berhasil dapat memicu tugas.
	integer	ID node penjadwalan.	10001
RuntimeConf	string	Pengaturan waktu proses untuk sumber data. Saat ini, hanya menentukan antrian EMR YARN dan mesin SQL untuk mengumpulkan tabel EMR yang didukung. Nilai mesin SQL yang valid: SPARK_SQL, KYUUBI, PRESTO_SQL, dan HIVE_SQL.	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Hooks	array<object>	Pengaturan panggilan balik selama epoch Instans tugas evaluasi kualitas data. Saat ini, hanya satu panggilan balik yang memblokir Instans node penjadwalan yang didukung.
	object	Pengaturan panggilan balik.
Type	string	Tipe aksi lanjutan. Nilai valid: BlockTaskInstance: Memblokir eksekusi Instans node DataWorks.	BlockTaskInstance
Condition	string	Penyebab yang memicu panggilan balik.	${severity} == "High" AND ${status} == "Critical"
Notifications	object	Konfigurasi notifikasi.
Condition	string	Penyebab yang memicu notifikasi.	${severity} == "High"
Notifications	array<object>	Pengaturan notifikasi.
	array<object>	Pengaturan notifikasi.
NotificationChannels	array<object>	Konfigurasi saluran notifikasi.
	object	Saluran notifikasi.
Channels	array	Saluran notifikasi.
	string	Saluran notifikasi. Nilai valid: Mail: email. Sms: pesan teks. Phone: panggilan telepon. Feishu: Lark. Weixin: WeChat. Dingding: DingTalk. Webhook: panggilan balik kustom.	Mail
NotificationReceivers	array<object>	Konfigurasi penerima notifikasi.
	object	Penerima notifikasi.
ReceiverType	string	Tipe penerima notifikasi. Nilai valid: AliUid: UID akun Alibaba Cloud. WebhookUrl: URL panggilan balik kustom. DingdingUrl: URL chatbot DingTalk. FeishuUrl: URL chatbot Lark. WeixinUrl: URL chatbot WeCom.	AliUid
ReceiverValues	array	Nilai spesifik dari penerima notifikasi.
	string	Nilai spesifik dari penerima notifikasi.	user1
Extension	string	Informasi ekstensi dalam format JSON. Misalnya, chatbot DingTalk mendukung menyebutkan semua anggota.	{"atAll":"true"}
DataSourceId	integer

Contoh

Respons sukses

JSONformat

{
  "RequestId": "691CA452-D37A-4ED0-****",
  "PagingInfo": {
    "TotalCount": "131",
    "PageSize": "10",
    "PageNumber": "1",
    "DataQualityEvaluationTasks": [
      {
        "Id": 10001,
        "Name": "Data quality verification task",
        "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": [
            10001
          ]
        },
        "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }",
        "Hooks": [
          {
            "Type": "BlockTaskInstance",
            "Condition": "${severity} == \"High\" AND ${status} == \"Critical\""
          }
        ],
        "Notifications": {
          "Condition": "${severity} == \"High\"",
          "Notifications": [
            {
              "NotificationChannels": [
                {
                  "Channels": [
                    "Mail"
                  ]
                }
              ],
              "NotificationReceivers": [
                {
                  "ReceiverType": "AliUid",
                  "ReceiverValues": [
                    "user1"
                  ],
                  "Extension": "{\"atAll\":\"true\"}"
                }
              ]
            }
          ]
        },
        "DataSourceId": 0
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.