Gunakan DescribeMetricRuleList untuk mengambil daftar aturan alert - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Mengkueri semua aturan dalam daftar aturan peringatan.

Deskripsi operasi

Topik ini memberikan contoh cara mengkueri semua aturan peringatan dalam daftar aturan peringatan di bawah akun Alibaba Cloud saat ini. Respons menunjukkan bahwa daftar aturan peringatan hanya berisi satu aturan peringatan. Nama aturan peringatan adalah Rule_01 dan ID-nya adalah applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****.

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

cms:DescribeMetricRuleList

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
MetricName	string	No	Nama metrik. Untuk informasi tentang cara mendapatkan nama metrik, lihat DescribeMetricMetaList atau Metrik layanan cloud. Catatan: Untuk metrik komposit, Anda hanya dapat mencari berdasarkan metrik pertama.	cpu_total
EnableState	boolean	No	Status aktif aturan peringatan. Nilai yang valid: true: Aktif. false: Nonaktif.	true
Namespace	string	No	Namespace layanan cloud. Untuk informasi tentang cara mendapatkan namespace layanan cloud, lihat DescribeMetricMetaList atau Metrik layanan cloud.	acs_ecs_dashboard
Page	integer	No	Nomor halaman. Nilai minimum: 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai minimum: 1. Nilai default: 10.	10
AlertState	string	No	Status aturan peringatan. Nilai yang valid: OK: Normal. ALARM: Peringatan. INSUFFICIENT_DATA: Tidak ada data.	OK
Dimensions	string	No	Dimensi pemantauan dari sumber daya yang ditentukan. Format: Kumpulan pasangan `key:value`, misalnya, `{"userId":"120886317861**"}` dan `{"instanceId":"i-2ze2d6j5uhg20x47**"}`.	{"instanceId":"i-2ze2d6j5uhg20x47****"}
RuleName	string	No	Nama aturan peringatan. Parameter ini mendukung pencarian fuzzy.	Rule_01
GroupId	string	No	ID grup aplikasi. Untuk informasi tentang cara mendapatkan ID grup aplikasi, lihat DescribeMonitorGroups.	7301****
RuleIds	string	No	ID aturan peringatan. Pisahkan beberapa ID dengan koma (,). Anda dapat mengkueri hingga 20 aturan peringatan sekaligus.	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****

Untuk informasi lebih lanjut tentang parameter permintaan umum, lihat Parameter umum.

Elemen respons

Element	Type	Description	Example
	object	Tidak ada.
Code	integer	Kode status HTTP. Catatan 200 menunjukkan keberhasilan.	200
Message	string	Pesan kesalahan.	The specified resource is not found.
RequestId	string	ID permintaan.	386C6712-335F-5054-930A-CC92B851ECBA
Total	string	Jumlah total catatan.	1
Success	boolean	Menunjukkan apakah operasi berhasil. Nilai yang valid: true: Berhasil. false: Gagal.	true
Alarms	object
Alarm	array<object>	Daftar aturan peringatan.
	array<object>	Tidak ada.
SilenceTime	integer	Periode bisu. Unit: detik. Nilai default: 86400. Nilai minimum: 3600. Jika data Pemantauan terus-menerus melebihi ambang batas aturan peringatan, hanya satu Pemberitahuan peringatan yang dikirim dalam setiap periode bisu.	86400
MetricName	string	Nama metrik.	cpu_total
Webhook	string	URL callback tempat Pemberitahuan peringatan dikirim. CloudMonitor mendorong informasi peringatan ke URL ini menggunakan permintaan POST. Hanya HTTP yang didukung.	https://www.aliyun.com
ContactGroups	string	Kelompok kontak peringatan.	ECS_Alarm
SourceType	string	Tipe aturan peringatan. Nilai valid: METRIC, yang menunjukkan aturan peringatan metrik deret waktu.	METRIC
Namespace	string	Namespace layanan Alibaba Cloud.	acs_ecs_dashboard
MailSubject	string	Subjek email peringatan.	"${serviceType}-${metricName}-${levelDescription} notification(${dimensions})"
NoEffectiveInterval	string	Rentang Waktu saat aturan peringatan tidak efektif.	00:00-05:30
EffectiveInterval	string	Periode efektif aturan peringatan.	05:31-23:59
RuleName	string	Nama aturan peringatan.	Rule_01
AlertState	string	Status aturan peringatan. Nilai valid: OK: Normal. ALARM: Peringatan. INSUFFICIENT_DATA: Tidak ada data.	OK
Period	string	Periode statistik.	60
RuleId	string	ID aturan peringatan.	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****
GroupName	string	Nama kelompok aplikasi. Catatan Parameter ini hanya dikembalikan jika aturan peringatan dikaitkan dengan kelompok aplikasi.	ECS_Group
GroupId	string	ID kelompok aplikasi.	7301****
Dimensions	string	Dimensi aturan peringatan.	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]
EnableState	boolean	Status aktif. Nilai valid: true: Aktif. false: Dinonaktifkan.	true
Resources	string	Sumber daya yang dikaitkan dengan aturan peringatan.	[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]
Escalations	object	Kondisi pemicu untuk berbagai tingkat peringatan.
Info	object	Kondisi pemicu untuk peringatan tingkat Info.
ComparisonOperator	string	Operator perbandingan untuk ambang batas tingkat Info. Nilai valid: GreaterThanOrEqualToThreshold: Lebih besar dari atau sama dengan ambang batas. GreaterThanThreshold: Lebih besar dari ambang batas. LessThanOrEqualToThreshold: Lebih kecil dari atau sama dengan ambang batas. LessThanThreshold: Lebih kecil dari ambang batas. NotEqualToThreshold: Tidak sama dengan ambang batas. GreaterThanYesterday: Lebih besar dari nilai pengatur waktu yang sama kemarin. LessThanYesterday: Lebih kecil dari nilai pengatur waktu yang sama kemarin. GreaterThanLastWeek: Lebih besar dari nilai pengatur waktu yang sama minggu lalu. LessThanLastWeek: Lebih kecil dari nilai pengatur waktu yang sama minggu lalu. GreaterThanLastPeriod: Lebih besar dari nilai pada periode terakhir. LessThanLastPeriod: Lebih kecil dari nilai pada periode terakhir.	GreaterThanOrEqualToThreshold
PreCondition	string	Prasyarat untuk peringatan tingkat Info. Parameter ini bekerja bersama dengan parameter ComparisonOperator ketika ComparisonOperator diatur ke perbandingan year-over-year atau periode-ke-periode. Misalnya, jika parameter ini diatur ke $Average>80, ComparisonOperator diatur ke GreaterThanYesterday, dan Threshold diatur ke 10, peringatan akan dipicu ketika nilai rata-rata lebih besar dari 80 dan telah meningkat lebih dari 10% dibandingkan dengan kemarin. Catatan $Average dalam $Average>0 adalah placeholder dalam format $nilai bidang hasil Pemantauan. CloudMonitor menggantinya dengan nilai statistik atau nilai Pemantauan mentah yang sesuai.	$Average>80
Times	integer	Jumlah kemunculan berturut-turut peringatan tingkat Info. Peringatan hanya dipicu ketika ambang batas terlampaui selama jumlah berturut-turut ini.	3
Threshold	string	Ambang batas untuk peringatan tingkat Info.	90
Statistics	string	Metode statistik untuk peringatan tingkat Info.	Average
Warn	object	Kondisi pemicu untuk peringatan tingkat Warn.
ComparisonOperator	string	Operator perbandingan untuk ambang batas tingkat Warn. Nilai valid: GreaterThanOrEqualToThreshold: Lebih besar dari atau sama dengan ambang batas. GreaterThanThreshold: Lebih besar dari ambang batas. LessThanOrEqualToThreshold: Lebih kecil dari atau sama dengan ambang batas. LessThanThreshold: Lebih kecil dari ambang batas. NotEqualToThreshold: Tidak sama dengan ambang batas. GreaterThanYesterday: Lebih besar dari nilai pengatur waktu yang sama kemarin. LessThanYesterday: Lebih kecil dari nilai pengatur waktu yang sama kemarin. GreaterThanLastWeek: Lebih besar dari nilai pengatur waktu yang sama minggu lalu. LessThanLastWeek: Lebih kecil dari nilai pengatur waktu yang sama minggu lalu. GreaterThanLastPeriod: Lebih besar dari nilai pada periode terakhir. LessThanLastPeriod: Lebih kecil dari nilai pada periode terakhir.	GreaterThanOrEqualToThreshold
PreCondition	string	Prasyarat untuk peringatan tingkat Warn. Parameter ini bekerja bersama dengan parameter ComparisonOperator ketika ComparisonOperator diatur ke perbandingan year-over-year atau periode-ke-periode. Misalnya, jika parameter ini diatur ke $Average>80, ComparisonOperator diatur ke GreaterThanYesterday, dan Threshold diatur ke 10, peringatan akan dipicu ketika nilai rata-rata lebih besar dari 80 dan telah meningkat lebih dari 10% dibandingkan dengan kemarin. Catatan $Average dalam $Average>0 adalah placeholder dalam format $nilai bidang hasil Pemantauan. CloudMonitor menggantinya dengan nilai statistik atau nilai Pemantauan mentah yang sesuai.	$Average>80
Times	integer	Jumlah kemunculan berturut-turut peringatan tingkat Warn. Peringatan hanya dipicu ketika ambang batas terlampaui selama jumlah berturut-turut ini.	3
Threshold	string	Ambang batas untuk peringatan tingkat Warn.	90
Statistics	string	Metode statistik untuk peringatan tingkat Warn.	Average
Critical	object	Kondisi pemicu untuk peringatan tingkat Critical.
ComparisonOperator	string	Operator perbandingan untuk ambang batas tingkat Critical. Nilai valid: GreaterThanOrEqualToThreshold: Lebih besar dari atau sama dengan ambang batas. GreaterThanThreshold: Lebih besar dari ambang batas. LessThanOrEqualToThreshold: Lebih kecil dari atau sama dengan ambang batas. LessThanThreshold: Lebih kecil dari ambang batas. NotEqualToThreshold: Tidak sama dengan ambang batas. GreaterThanYesterday: Lebih besar dari nilai pengatur waktu yang sama kemarin. LessThanYesterday: Lebih kecil dari nilai pengatur waktu yang sama kemarin. GreaterThanLastWeek: Lebih besar dari nilai pengatur waktu yang sama minggu lalu. LessThanLastWeek: Lebih kecil dari nilai pengatur waktu yang sama minggu lalu. GreaterThanLastPeriod: Lebih besar dari nilai pada periode terakhir. LessThanLastPeriod: Lebih kecil dari nilai pada periode terakhir.	GreaterThanOrEqualToThreshold
PreCondition	string	Prasyarat untuk peringatan tingkat Critical. Parameter ini bekerja bersama dengan parameter ComparisonOperator ketika ComparisonOperator diatur ke perbandingan year-over-year atau periode-ke-periode. Misalnya, jika parameter ini diatur ke $Average>80, ComparisonOperator diatur ke GreaterThanYesterday, dan Threshold diatur ke 10, peringatan akan dipicu ketika nilai rata-rata lebih besar dari 80 dan telah meningkat lebih dari 10% dibandingkan dengan kemarin. Catatan $Average dalam $Average>0 adalah placeholder dalam format `$nilai bidang hasil Pemantauan`. CloudMonitor menggantinya dengan nilai statistik atau nilai Pemantauan mentah yang sesuai.	$Average>80
Times	integer	Jumlah kemunculan berturut-turut peringatan tingkat Critical. Peringatan hanya dipicu ketika ambang batas terlampaui selama jumlah berturut-turut ini.	3
Threshold	string	Ambang batas untuk peringatan tingkat Critical.	90
Statistics	string	Metode statistik untuk peringatan tingkat Critical.	Average
NoDataPolicy	string	Metode pemrosesan ketika tidak ada data Pemantauan yang ditemukan. Nilai valid: KEEP_LAST_STATE (default): Tidak ada aksi yang diambil. INSUFFICIENT_DATA: Konten peringatan menunjukkan bahwa data tidak mencukupi. OK: Normal.	KEEP_LAST_STATE
CompositeExpression	object	Kondisi peringatan untuk beberapa metrik. Catatan Kondisi metrik tunggal dan multi-metrik saling eksklusif dan tidak dapat diatur secara bersamaan.
Level	string	Tingkat peringatan. Nilai valid: CRITICAL: Kritis. WARN: Peringatan. INFO: Informasi.	CRITICAL
ExpressionList	object
ExpressionList	array<object>	Daftar kondisi peringatan yang dibuat dalam mode standar.
	object	Tidak ada.
MetricName	string	Nama metrik layanan Alibaba Cloud.	cpu_total
Period	integer	Periode agregasi metrik. Unit: detik.	60
Statistics	string	Metode statistik metrik. Nilai valid: $Maximum: Nilai maksimum. $Minimum: Nilai minimum. $Average: Nilai rata-rata. $Availability: Laju aktif (biasanya digunakan untuk Pemantauan situs). Catatan `$` adalah awalan terpadu untuk metrik. Untuk layanan Alibaba Cloud yang didukung, lihat metrik Pemantauan layanan cloud.	$Maximum
ComparisonOperator	string	Operator perbandingan untuk ambang batas. Nilai valid: GreaterThanOrEqualToThreshold: Lebih besar dari atau sama dengan ambang batas. GreaterThanThreshold: Lebih besar dari ambang batas. LessThanOrEqualToThreshold: Lebih kecil dari atau sama dengan ambang batas. LessThanThreshold: Lebih kecil dari ambang batas. NotEqualToThreshold: Tidak sama dengan ambang batas. GreaterThanYesterday: Lebih besar dari nilai pengatur waktu yang sama kemarin. LessThanYesterday: Lebih kecil dari nilai pengatur waktu yang sama kemarin. GreaterThanLastWeek: Lebih besar dari nilai pengatur waktu yang sama minggu lalu. LessThanLastWeek: Lebih kecil dari nilai pengatur waktu yang sama minggu lalu. GreaterThanLastPeriod: Lebih besar dari nilai pada periode terakhir. LessThanLastPeriod: Lebih kecil dari nilai pada periode terakhir.	GreaterThanOrEqualToThreshold
Threshold	string	Ambang batas peringatan.	90
ExpressionListJoin	string	Hubungan antara kondisi peringatan multi-metrik. Nilai valid: `&&`: Peringatan hanya dipicu ketika semua metrik memenuhi kondisi peringatan. Peringatan hanya dipicu ketika semua ekspresi dalam ExpressionList adalah `true`. `\|\|`: Peringatan dipicu ketika metrik apa pun memenuhi kondisi peringatan.	\|\|
ExpressionRaw	string	Kondisi peringatan yang dibuat menggunakan ekspresi. Skenario berikut didukung tetapi tidak terbatas pada: Mengatur blacklist peringatan untuk Sumber daya tertentu. Misalnya, $instanceId != 'i-io8kfvcpp7x5**' ``&&`` $Average > 50 menunjukkan bahwa tidak ada peringatan yang dipicu untuk Instans `i-io8kfvcpp7x5` meskipun `Average`-nya melebihi 50. Mengatur ambang batas peringatan khusus untuk Instans tertentu. Misalnya, `$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)` menunjukkan bahwa peringatan dipicu untuk Instans `i-io8kfvcpp7x5**` hanya ketika `Average`-nya melebihi 80, sedangkan peringatan dipicu untuk Instans lain ketika `Average`-nya melebihi 50. Membatasi jumlah Instans yang melebihi ambang batas. Misalnya, `count($Average > 20) > 3` menunjukkan bahwa peringatan hanya dipicu ketika lebih dari tiga Instans memiliki `Average` lebih besar dari 20.	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)
Times	integer	Jumlah kali kondisi peringatan harus dipenuhi sebelum Pemberitahuan peringatan dikirim.	3
Labels	object
Labels	array<object>	Tag aturan peringatan.
	object	Tidak ada.
Key	string	Kunci tag aturan peringatan.	cmsRuleKey
Value	string	Nilai tag aturan peringatan.	cmsRuleValue
Prometheus	object	Peringatan Prometheus. Catatan Atur parameter ini hanya ketika Anda membuat aturan peringatan Prometheus untuk Pemantauan Cloud Hibrida.
PromQL	string	Pernyataan pencarian PromQL. Catatan Data yang diperoleh oleh pernyataan pencarian PromQL adalah data peringatan. Sertakan ambang batas peringatan dalam pernyataan ini.	CpuUsage{instanceId="xxxx"}[1m]>90
Level	string	Tingkat peringatan. Nilai valid: CRITICAL: Kritis. WARN: Peringatan. INFO: Informasi.	CRITICAL
Times	integer	Jumlah kali kondisi peringatan harus dipenuhi sebelum Pemberitahuan peringatan dikirim.	3
Annotations	object
Annotations	array<object>	Anotasi untuk peringatan Prometheus. Kunci dan nilai anotasi dirender untuk membantu Anda memahami metrik atau aturan peringatan. Catatan Fitur ini setara dengan fitur Anotasi di Prometheus.
	object	Tidak ada.
Key	string	Kunci anotasi.	summary
Value	string	Nilai anotasi.	{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }
SendOK	boolean	Apakah pemberitahuan pemulihan dinonaktifkan. Nilai valid: true (dinonaktifkan) dan false (diaktifkan).	true
ProductCategory	string	Tipe layanan Alibaba Cloud.	slb
GmtCreate	integer	Waktu saat aturan dibuat. Nilainya adalah Stempel waktu UNIX.	1760432061000
GmtUpdate	string	Waktu saat aturan terakhir diperbarui. Nilainya adalah Stempel waktu UNIX.	1760432061000

Contoh

Respons sukses

JSONformat

{
  "Code": 200,
  "Message": "The specified resource is not found.",
  "RequestId": "386C6712-335F-5054-930A-CC92B851ECBA",
  "Total": "1",
  "Success": true,
  "Alarms": {
    "Alarm": [
      {
        "SilenceTime": 86400,
        "MetricName": "cpu_total",
        "Webhook": "https://www.aliyun.com",
        "ContactGroups": "ECS_Alarm",
        "SourceType": "METRIC",
        "Namespace": "acs_ecs_dashboard",
        "MailSubject": "\"${serviceType}-${metricName}-${levelDescription} notification(${dimensions})\"",
        "NoEffectiveInterval": "00:00-05:30",
        "EffectiveInterval": "05:31-23:59",
        "RuleName": "Rule_01",
        "AlertState": "OK",
        "Period": "60",
        "RuleId": "applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****",
        "GroupName": "ECS_Group",
        "GroupId": "7301****",
        "Dimensions": "[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]",
        "EnableState": true,
        "Resources": "[{\\\"instanceId\\\":\\\"i-2ze2d6j5uhg20x47****\\\"}]",
        "Escalations": {
          "Info": {
            "ComparisonOperator": "GreaterThanOrEqualToThreshold",
            "PreCondition": "$Average>80",
            "Times": 3,
            "Threshold": "90",
            "Statistics": "Average"
          },
          "Warn": {
            "ComparisonOperator": "GreaterThanOrEqualToThreshold",
            "PreCondition": "$Average>80",
            "Times": 3,
            "Threshold": "90",
            "Statistics": "Average"
          },
          "Critical": {
            "ComparisonOperator": "GreaterThanOrEqualToThreshold",
            "PreCondition": "$Average>80",
            "Times": 3,
            "Threshold": "90",
            "Statistics": "Average"
          }
        },
        "NoDataPolicy": "KEEP_LAST_STATE",
        "CompositeExpression": {
          "Level": "CRITICAL",
          "ExpressionList": {
            "ExpressionList": [
              {
                "MetricName": "cpu_total",
                "Period": 60,
                "Statistics": "$Maximum",
                "ComparisonOperator": "GreaterThanOrEqualToThreshold",
                "Threshold": "90"
              }
            ]
          },
          "ExpressionListJoin": "||",
          "ExpressionRaw": "$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)",
          "Times": 3
        },
        "Labels": {
          "Labels": [
            {
              "Key": "cmsRuleKey",
              "Value": "cmsRuleValue"
            }
          ]
        },
        "Prometheus": {
          "PromQL": "CpuUsage{instanceId=\"xxxx\"}[1m]>90",
          "Level": "CRITICAL",
          "Times": 3,
          "Annotations": {
            "Annotations": [
              {
                "Key": "summary",
                "Value": "{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }"
              }
            ]
          }
        },
        "SendOK": true,
        "ProductCategory": "slb",
        "GmtCreate": 1760432061000,
        "GmtUpdate": "1760432061000"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.	参数错误
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidAuthorization	The Request is not authorization.
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.