ListDataQualityAlertRules - DataWorks - Alibaba Cloud Documentation Center

Mengkueri daftar aturan pemberitahuan peringatan kualitas data dalam sebuah proyek.

Deskripsi operasi

DataWorks Basic Edition or a higher edition is required.

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:ListDataQualityAlertRules

list

*All Resource

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID proyek.	10001
DataQualityScanId	integer	No	ID monitor kualitas data yang menjadi target aturan pemberitahuan peringatan.	10001
SortBy	string	No	Daftar bidang pengurutan. Mendukung bidang seperti pengatur waktu modifikasi terakhir dan pengatur waktu pembuatan. Format: "SortField+SortOrder (Desc/Asc)", dengan Asc sebagai nilai default. Nilai valid: CreateTime (Desc/Asc) Id (Desc/Asc)	CreateTime Desc
PageNumber	integer	Yes	Nomor halaman hasil.	1
PageSize	integer	Yes	Jumlah rekaman yang dikembalikan pada setiap halaman.	10

Elemen respons

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	0bc14115***159376359
PageInfo	object	Alert rule configurations.
TotalCount	integer	The total number of entries returned.	335
PageNumber	integer	The current page number.	1
PageSize	integer	The number of records per page.	10
DataQualityAlertRules	array<object>	The list of alert rule configurations.
	array<object>	Alert rule configurations.
Condition	string	The alert conditions.	results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }
Target	object	Monitored targets of the data quality alert rule.
Type	string	The type of the monitored target. Only DataQualityScan is supported.	DataQualityScan
Ids	array	The list of monitored target IDs
	integer	The ID of the monitored target.	7638999336
ProjectId	integer	The project ID.	59094
Id	integer	The ID of the data quality monitor alert rule.	26433
Notification	object	Alert notification configurations.
Receivers	array<object>	The alert recipients.
	object	The alert recipients.
Extension	string	Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.	{"atAll":true}
ReceiverType	string	The type of alert recipients. ShiftSchedule WebhookUrl FeishuUrl TaskOwner WeixinUrl DingdingUrl DataQualityScanOwner AliUid	AliUid
ReceiverValues	array	The value of alert recipients.
	string	The value of alert recipients. If ReceiverType is AliUid, enter the Alibaba Cloud account ID. If ReceiverType is ShiftSchedule, enter the shift schedule ID. If ReceiverType is WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, enter the corresponding URL.	https://oapi.dingtalk.com/robot/send?access_token=a30bae7******
Channels	array	In Channels, you can set both Email and Sms at the same time. In other cases, only one channel can be set.
	string	Alert channels. Mail Weixin Feishu Phone Sms Webhook	Sms

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 335,
    "PageNumber": 1,
    "PageSize": 10,
    "DataQualityAlertRules": [
      {
        "Condition": "results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }",
        "Target": {
          "Type": "DataQualityScan",
          "Ids": [
            7638999336
          ]
        },
        "ProjectId": 59094,
        "Id": 26433,
        "Notification": {
          "Receivers": [
            {
              "Extension": "{\"atAll\":true}",
              "ReceiverType": "AliUid",
              "ReceiverValues": [
                "https://oapi.dingtalk.com/robot/send?access_token=a30bae7******"
              ]
            }
          ],
          "Channels": [
            "Sms"
          ]
        }
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.