ListDIAlarmRules API untuk Pemantauan Peringatan Tugas Sinkronisasi - DataWorks - Alibaba Cloud -

Mengambil daftar aturan peringatan yang dikonfigurasi untuk tugas sinkronisasi.

Deskripsi operasi

Aturan peringatan dapat dikonfigurasi ketika tugas Anda mencakup sinkronisasi real-time.

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

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DIJobId	integer	Yes	ID tugas yang terkait dengan aturan peringatan.	11260
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object	Hasil yang dikembalikan.
RequestId	string	ID permintaan.	74C2FECD-5B3A-554A-BCF5-35****
DIAlarmRulePaging	object	Informasi paginasi.
TotalCount	integer	Jumlah total entri yang dikembalikan.	2
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman.	10
DIJobAlarmRules	array<object>	Aturan peringatan.
	array<object>	Detail aturan peringatan.
DIAlarmRuleId	integer	The alert rule ID.	41998
DIJobId	integer	The ID of the task with which the alert rule is associated.	11260
Description	string	The description of the alert rule.	mysql synchronizes to hologres heartbeat alert
MetricType	string	The metric type in the alert rule. Valid values: Heartbeat FailoverCount Delay	Heartbeat
Enabled	boolean	Indicates whether the alert rule is enabled.	true
TriggerConditions	array<object>	The conditions that are used to trigger the alert rule.
	object	The condition that is used to trigger the alert rule.
Severity	string	The severity level. Valid values: Warning Critical	Warning
Duration	integer	The time interval for alert calculation. Unit: minutes.	15
Threshold	integer	The alert threshold. If the alert rule is for task status, no threshold is used. If the alert rule is for failovers, the threshold is the number of failovers. If the alert rule is for latency, the threshold is the latency duration, in seconds.	5
NotificationSettings	object	The alert notification settings.
NotificationChannels	array<object>	The alert notification methods.
	object	The alert notification method.
Severity	string	The severity level. Valid values: Warning Critical	Warning
Channels	array	The alert notification methods.
	string	The alert notification method. Valid values: Mail: email Phone: phone call Sms: text message Ding: DingTalk chatbot token	Ding
NotificationReceivers	array<object>	The settings of alert notification recipients.
	object	The setting of an alert notification recipient.
ReceiverType	string	The recipient type. Valid values: AliyunUid and DingToken. If the alert notification method is Mail, Phone, or Sms, the value of this parameter is AliyunUid, which indicates the Alibaba Cloud account ID. If the alert notification method is Ding, the value of this parameter is DingToken, which indicates the DingTalk chatbot token.	DingToken
ReceiverValues	array	The recipients.
	string	The recipient. If the recipient type is Alibaba Cloud account ID, the value of this parameter is the Alibaba Cloud account ID of a user. If the recipient type is DingTalk chatbot token, the value of this parameter is the token of a DingTalk chatbot.	token1
InhibitionInterval	integer	The duration of the alert suppression interval. Unit: minutes.	5

Contoh

Respons sukses

JSONformat

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-35****",
  "DIAlarmRulePaging": {
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "DIAlarmRuleId": 41998,
        "DIJobId": 11260,
        "Description": "mysql synchronizes to hologres heartbeat alert",
        "MetricType": "Heartbeat",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Warning",
            "Duration": 15,
            "Threshold": 5
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Warning",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "InhibitionInterval": 5
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.