ListAlertRules API Reference untuk Custom Monitoring Alert - DataWorks - Alibaba Cloud - DataWorks

Mengkueri daftar aturan peringatan pemantauan kustom.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
Owner	string	No	ID akun Alibaba Cloud yang digunakan oleh pemilik aturan.	1933790683****
TaskIds	array	No	ID dari tugas penjadwalan.
	integer	No	ID dari tugas penjadwalan.	1234
Types	array	No	Kondisi pemicu peringatan.
	string	No	Jenis peringatan. Nilai valid: Finished: Instance berhasil dijalankan. UnFinished: Instance tidak selesai dijalankan sebelum titik waktu yang ditentukan. Error: Kesalahan terjadi pada instance. CycleUnfinished: Instance tidak selesai dijalankan sesuai harapan dalam siklus tertentu. Timeout: Instance melebihi batas waktu. InstanceTransferComplete: Instance dihasilkan oleh node yang dipicu otomatis. InstanceTransferFluctuate: Jumlah instance yang dihasilkan berfluktuasi. ExhaustedError: Kesalahan tetap terjadi setelah instance dijalankan ulang secara otomatis. InstanceKeyword: Instance dengan kesalahan berisi kata kunci yang ditentukan. InstanceErrorCount: Jumlah instance yang mengalami kesalahan mencapai ambang batas yang ditentukan. InstanceErrorPercentage: Proporsi instance yang mengalami kesalahan di workspace terhadap jumlah total instance mencapai ambang batas yang ditentukan. ResourceGroupPercentage: Tingkat penggunaan grup sumber daya mencapai ambang batas yang ditentukan. ResourceGroupWaitCount: Jumlah instance yang menunggu sumber daya di grup sumber daya mencapai ambang batas yang ditentukan.	Error
Receiver	string	No	ID akun Alibaba Cloud yang digunakan oleh penerima peringatan.	1933790683****
Name	string	No	Nama aturan.	error_rule
PageNumber	integer	Yes	Nomor halaman. Halaman dimulai dari halaman 1.	1
PageSize	integer	Yes	Jumlah entri per halaman. Nilai maksimum: 100.	10

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	A6C6B486-E3A2-5D52-9E76-D9380485D946
PagingInfo	object	Informasi paginasi.
TotalCount	integer	Jumlah total entri yang dikembalikan.	5
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman.	10
AlertRules	array<object>	Aturan.
	array<object>
Id	integer	The rule ID.	22125
Name	string	The name of the rule.	error_test
Owner	string	The ID of the Alibaba Cloud account used by the owner of the rule.	1933790683****
Enabled	boolean	Indicates whether the rule is enabled.	true
TriggerCondition	object	The alert triggering condition.
Type	string	The alert type. Valid values: Finished: An instance is successfully run. UnFinished: An instance does not finish running before a specified point in time. Error: An error occurs on an instance. CycleUnfinished: An instance does not finish running as expected within a specific cycle. Timeout: An instance times out. InstanceTransferComplete: An instance is generated by the auto triggered node. InstanceTransferFluctuate: The number of generated instances fluctuates. ExhaustedError: An error persists after an instance is automatically rerun. InstanceKeyword: An instance with errors contains specified keywords. InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold. InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold. ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold. ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.	Error
Extension	object	The extended information about the rule. This parameter is required for specific types of alerts.
Error	object	The configuration for an alert of the Error type.
StreamTaskIds	array	The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.
	integer	The ID of the real-time computing task.	123
AutoRerunAlertEnabled	boolean	Indicates whether an alert is triggered if a batch synchronization task is automatically rerun upon a failure.	false
Timeout	object	The configuration for an alert of the Timeout type.
TimeoutInMinutes	integer	The timeout period. Unit: minutes.	10
UnFinished	object	The configuration for an alert of the UnFinished type.
UnFinishedTime	string	The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59].	12:00
CycleUnfinished	object	The configuration for an alert of the CycleUnfinished type.
CycleAndTime	array<object>	The configurations of the scheduling cycle and timeout period of the instance.
	object
CycleId	integer	The ID of the scheduling cycle of the instance. Valid values: [1,288].	1
Time	string	The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59].	01:00
InstanceErrorCount	object	The configuration for an alert of the InstanceErrorCount type.
Count	integer	The maximum number of instances on which an error occurs. Valid values: [1,10000].	10
InstanceErrorPercentage	object	The configuration for an alert of the InstanceErrorPercentage type.
Percentage	integer	The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: [1-100].	10
InstanceTransferFluctuate	object	The configuration for an alert of the InstanceTransferFluctuate type.
Trend	string	The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values: abs: the absolute value. The number of instances increases or decreases. increase: The number of instances increases. decrease: The number of instances decreases.	abs
Percentage	integer	The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: [1-100].	10
Target	object	The monitored objects.
Type	string	The type of the monitored objects. Valid values: Task: node Baseline: baseline Project: workspace BizProcess: workflow	Task
Ids	array	The IDs of monitored objects.
	integer	The ID of the monitored object.	32567
AllowTasks	array	The nodes that are not to be monitored.
	integer	The ID of the node that is not to be monitored.	123123

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D938048****",
  "PagingInfo": {
    "TotalCount": 5,
    "PageNumber": 1,
    "PageSize": 10,
    "AlertRules": [
      {
        "Id": 22125,
        "Name": "error_test",
        "Owner": "1933790683****",
        "Enabled": true,
        "TriggerCondition": {
          "Type": "Error",
          "Extension": {
            "Error": {
              "StreamTaskIds": [
                123
              ],
              "AutoRerunAlertEnabled": false
            },
            "Timeout": {
              "TimeoutInMinutes": 10
            },
            "UnFinished": {
              "UnFinishedTime": "12:00"
            },
            "CycleUnfinished": {
              "CycleAndTime": [
                {
                  "CycleId": 1,
                  "Time": "01:00"
                }
              ]
            },
            "InstanceErrorCount": {
              "Count": 10
            },
            "InstanceErrorPercentage": {
              "Percentage": 10
            },
            "InstanceTransferFluctuate": {
              "Trend": "abs",
              "Percentage": 10
            }
          },
          "Target": {
            "Type": "Task",
            "Ids": [
              32567
            ],
            "AllowTasks": [
              123123
            ]
          }
        }
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.