DescribeMetricRuleList - Cloud Monitor

Mengambil daftar aturan peringatan.

Deskripsi operasi

Topik ini memberikan contoh cara mengambil semua aturan peringatan untuk Akun Alibaba Cloud Anda. Responsnya mengembalikan satu aturan peringatan bernama Rule_01 dengan ID 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 selengkapnya tentang cara mendapatkan nama metrik, lihat DescribeMetricMetaList atau Cloud service metrics. Catatan: Untuk metrik komposit, Anda hanya dapat mengambilnya berdasarkan metrik pertama.	cpu_total
EnableState	boolean	No	Status aturan peringatan. Nilai yang valid: true: diaktifkan. false: dinonaktifkan.	true
Namespace	string	No	Namespace layanan Alibaba Cloud. Untuk informasi selengkapnya tentang cara mendapatkan namespace layanan Alibaba Cloud, lihat DescribeMetricMetaList atau Cloud service metrics.	acs_ecs_dashboard
Page	integer	No	Nomor halaman. Dimulai dari 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Dimulai dari 1. Nilai default: 10.	10
AlertState	string	No	Status aturan peringatan. Nilai yang valid: OK: Normal. ALARM: Peringatan dipicu. INSUFFICIENT_DATA: Data tidak mencukupi.	OK
Dimensions	string	No	Dimensi yang menentukan resource yang akan dipantau. Nilainya berupa kumpulan pasangan kunci-nilai. Format: `key:value`. Contohnya, `{"userId":"120886317861**"}` dan `{"instanceId":"i-2ze2d6j5uhg20x47**"}`.	{"instanceId":"i-2ze2d6j5uhg20x47****"}
RuleName	string	No	Nama aturan peringatan. Pencarian fuzzy didukung.	Rule_01
GroupId	string	No	ID kelompok aplikasi. Untuk informasi selengkapnya tentang cara mendapatkan ID kelompok aplikasi, lihat DescribeMonitorGroups.	7301****
RuleIds	string	No	ID aturan peringatan. Anda dapat menentukan hingga 20 ID. Pisahkan beberapa ID dengan koma (,).	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****

Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Common parameters.

Elemen respons

Element	Type	Description	Example
	object	Tidak ada.
Code	integer	Kode status. Catatan Nilai 200 menunjukkan bahwa permintaan berhasil.	200
Message	string	Pesan error.	The specified resource is not found.
RequestId	string	ID permintaan.	386C6712-335F-5054-930A-CC92B851ECBA
Total	string	Jumlah total entri.	1
Success	boolean	Menunjukkan apakah operasi berhasil. Nilai yang valid: true: Operasi berhasil. false: Operasi gagal.	true
Alarms	object
Alarm	array<object>	Daftar aturan peringatan.
	array<object>	Tidak ada.
SilenceTime	integer	Periode bisu. Satuan: detik. Nilai default: 86400. Nilai minimum: 3600. Jika nilai metrik terus-menerus melebihi ambang batas peringatan, pemberitahuan peringatan hanya dikirim sekali dalam setiap periode bisu.	86400
MetricName	string	Nama metrik.	cpu_total
Webhook	string	URL panggilan balik tempat pemberitahuan peringatan dikirim. CloudMonitor mendorong pemberitahuan peringatan ke URL yang ditentukan melalui permintaan POST. Hanya HTTP yang didukung.	https://www.aliyun.com
ContactGroups	string	Kelompok kontak.	ECS_Alarm
SourceType	string	Jenis aturan peringatan. Nilai METRIC menunjukkan aturan peringatan metrik deret waktu.	METRIC
Namespace	string	Namespace layanan Alibaba Cloud.	acs_ecs_dashboard
MailSubject	string	Subjek email pemberitahuan peringatan.	"${serviceType}-${metricName}-${levelDescription}通知（${dimensions}）"
NoEffectiveInterval	string	Periode waktu ketika aturan peringatan tidak efektif.	00:00-05:30
EffectiveInterval	string	Periode waktu ketika aturan peringatan efektif.	05:31-23:59
RuleName	string	Nama aturan peringatan.	Rule_01
AlertState	string	Status aturan peringatan. Nilai yang valid: OK: Normal. ALARM: Peringatan dipicu. INSUFFICIENT_DATA: Data tidak mencukupi.	OK
Period	string	Periode statistik.	60
RuleId	string	ID aturan peringatan.	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****
GroupName	string	Nama kelompok aplikasi. Catatan Parameter ini ditampilkan 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 diaktifkan. Nilai yang valid: true: diaktifkan. false: dinonaktifkan.	true
Resources	string	Resource yang dikaitkan dengan aturan peringatan.	[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]
Escalations	object	Kondisi untuk memicu peringatan pada berbagai level.
Info	object	Kondisi untuk memicu peringatan level Info.
ComparisonOperator	string	Operator perbandingan untuk ambang batas peringatan level Info. Nilai yang valid: GreaterThanOrEqualToThreshold: lebih besar dari atau sama dengan. GreaterThanThreshold: lebih besar dari. LessThanOrEqualToThreshold: kurang dari atau sama dengan. LessThanThreshold: kurang dari. NotEqualToThreshold: tidak sama dengan. GreaterThanYesterday: lebih besar dari nilai pada waktu yang sama kemarin. LessThanYesterday: kurang dari nilai pada waktu yang sama kemarin. GreaterThanLastWeek: lebih besar dari nilai pada waktu yang sama minggu lalu. LessThanLastWeek: kurang dari nilai pada waktu yang sama minggu lalu. GreaterThanLastPeriod: lebih besar dari nilai pada siklus sebelumnya. LessThanLastPeriod: kurang dari nilai pada siklus sebelumnya.	GreaterThanOrEqualToThreshold
PreCondition	string	Prasyarat untuk peringatan level Info. Parameter ini digunakan bersama `ComparisonOperator` ketika `ComparisonOperator` diatur ke nilai yang menunjukkan perbandingan hari-ke-hari atau minggu-ke-minggu. Contohnya, jika Anda mengatur parameter ini ke `$Average>80`, `ComparisonOperator` ke `GreaterThanYesterday`, dan `Threshold` ke `10`, peringatan dipicu ketika nilai rata-rata lebih besar dari 80 dan peningkatan hari-ke-hari sebesar 10%. Catatan Dalam `$Average>0`, `$Average` adalah placeholder dalam format `$metric-field-value`. CloudMonitor menggantinya dengan nilai statistik yang sesuai atau nilai metrik aslinya.	$Average>80
Times	integer	Jumlah kali berturut-turut peringatan level Info dipicu. Peringatan hanya dipicu jika nilai metrik melebihi ambang batas sebanyak jumlah kali yang ditentukan secara berturut-turut.	3
Threshold	string	Ambang batas untuk peringatan level Info.	90
Statistics	string	Metode statistik untuk peringatan level Info.	Average
Warn	object	Kondisi untuk memicu peringatan level Warn.
ComparisonOperator	string	Operator perbandingan untuk ambang batas peringatan level Warn. Nilai yang valid: GreaterThanOrEqualToThreshold: lebih besar dari atau sama dengan. GreaterThanThreshold: lebih besar dari. LessThanOrEqualToThreshold: kurang dari atau sama dengan. LessThanThreshold: kurang dari. NotEqualToThreshold: tidak sama dengan. GreaterThanYesterday: lebih besar dari nilai pada waktu yang sama kemarin. LessThanYesterday: kurang dari nilai pada waktu yang sama kemarin. GreaterThanLastWeek: lebih besar dari nilai pada waktu yang sama minggu lalu. LessThanLastWeek: kurang dari nilai pada waktu yang sama minggu lalu. GreaterThanLastPeriod: lebih besar dari nilai pada siklus sebelumnya. LessThanLastPeriod: kurang dari nilai pada siklus sebelumnya.	GreaterThanOrEqualToThreshold
PreCondition	string	Prasyarat untuk peringatan level Warn. Parameter ini digunakan bersama `ComparisonOperator` ketika `ComparisonOperator` diatur ke nilai yang menunjukkan perbandingan hari-ke-hari atau minggu-ke-minggu. Contohnya, jika Anda mengatur parameter ini ke `$Average>80`, `ComparisonOperator` ke `GreaterThanYesterday`, dan `Threshold` ke `10`, peringatan dipicu ketika nilai rata-rata lebih besar dari 80 dan peningkatan hari-ke-hari sebesar 10%. Catatan Dalam `$Average>0`, `$Average` adalah placeholder dalam format `$metric-field-value`. CloudMonitor menggantinya dengan nilai statistik yang sesuai atau nilai metrik aslinya.	$Average>80
Times	integer	Jumlah kali berturut-turut peringatan level Warn dipicu. Peringatan hanya dipicu jika nilai metrik melebihi ambang batas sebanyak jumlah kali yang ditentukan secara berturut-turut.	3
Threshold	string	Ambang batas untuk peringatan level Warn.	90
Statistics	string	Metode statistik untuk peringatan level Warn.	Average
Critical	object	Kondisi untuk memicu peringatan level Critical.
ComparisonOperator	string	Operator perbandingan untuk ambang batas peringatan level Critical. Nilai yang valid: GreaterThanOrEqualToThreshold: lebih besar dari atau sama dengan. GreaterThanThreshold: lebih besar dari. LessThanOrEqualToThreshold: kurang dari atau sama dengan. LessThanThreshold: kurang dari. NotEqualToThreshold: tidak sama dengan. GreaterThanYesterday: lebih besar dari nilai pada waktu yang sama kemarin. LessThanYesterday: kurang dari nilai pada waktu yang sama kemarin. GreaterThanLastWeek: lebih besar dari nilai pada waktu yang sama minggu lalu. LessThanLastWeek: kurang dari nilai pada waktu yang sama minggu lalu. GreaterThanLastPeriod: lebih besar dari nilai pada siklus sebelumnya. LessThanLastPeriod: kurang dari nilai pada siklus sebelumnya.	GreaterThanOrEqualToThreshold
PreCondition	string	Prasyarat untuk peringatan level Critical. Parameter ini digunakan bersama `ComparisonOperator` ketika `ComparisonOperator` diatur ke nilai yang menunjukkan perbandingan hari-ke-hari atau minggu-ke-minggu. Contohnya, jika Anda mengatur parameter ini ke `$Average>80`, `ComparisonOperator` ke `GreaterThanYesterday`, dan `Threshold` ke `10`, peringatan dipicu ketika nilai rata-rata lebih besar dari 80 dan peningkatan hari-ke-hari sebesar 10%. Catatan Dalam `$Average>0`, `$Average` adalah placeholder dalam format `$metric-field-value`. CloudMonitor menggantinya dengan nilai statistik yang sesuai atau nilai metrik aslinya.	$Average>80
Times	integer	Jumlah kali berturut-turut peringatan level Critical dipicu. Peringatan hanya dipicu jika nilai metrik melebihi ambang batas sebanyak jumlah kali yang ditentukan secara berturut-turut.	3
Threshold	string	Ambang batas untuk peringatan level Critical.	90
Statistics	string	Metode statistik untuk peringatan level Critical.	Average
NoDataPolicy	string	Metode penanganan peringatan saat tidak tersedia data pemantauan. Nilai yang valid: KEEP_LAST_STATE (default): Tidak ada tindakan yang diambil. INSUFFICIENT_DATA: Peringatan dengan konten `no data` dipicu. OK: Aturan peringatan dianggap normal.	KEEP_LAST_STATE
CompositeExpression	object	Kondisi peringatan untuk beberapa metrik. Catatan Kondisi peringatan metrik tunggal dan multi-metrik saling eksklusif. Anda tidak dapat menentukan keduanya sekaligus.
Level	string	Level peringatan. Nilai yang valid: CRITICAL: critical. WARN: warning. INFO: info.	CRITICAL
ExpressionList	object
ExpressionList	array<object>	Daftar kondisi peringatan yang dibuat dalam mode standar.
	object	Tidak ada.
MetricName	string	Nama metrik untuk layanan Alibaba Cloud.	cpu_total
Period	integer	Periode agregasi metrik. Satuan: detik.	60
Statistics	string	Metode statistik untuk metrik. Nilai yang valid: $Maximum: nilai maksimum. $Minimum: nilai minimum. $Average: nilai rata-rata. $Availability: tingkat ketersediaan (biasanya digunakan untuk Pemantauan situs). Catatan Tanda `$` adalah awalan terpadu untuk metrik. Untuk informasi selengkapnya tentang layanan Alibaba Cloud yang didukung, lihat Cloud service metrics.	$Maximum
ComparisonOperator	string	Operator perbandingan untuk ambang batas peringatan. Nilai yang valid: GreaterThanOrEqualToThreshold: lebih besar dari atau sama dengan. GreaterThanThreshold: lebih besar dari. LessThanOrEqualToThreshold: kurang dari atau sama dengan. LessThanThreshold: kurang dari. NotEqualToThreshold: tidak sama dengan. GreaterThanYesterday: lebih besar dari nilai pada waktu yang sama kemarin. LessThanYesterday: kurang dari nilai pada waktu yang sama kemarin. GreaterThanLastWeek: lebih besar dari nilai pada waktu yang sama minggu lalu. LessThanLastWeek: kurang dari nilai pada waktu yang sama minggu lalu. GreaterThanLastPeriod: lebih besar dari nilai pada siklus sebelumnya. LessThanLastPeriod: kurang dari nilai pada siklus sebelumnya.	GreaterThanOrEqualToThreshold
Threshold	string	Ambang batas peringatan.	90
ExpressionListJoin	string	Hubungan antara kondisi peringatan untuk beberapa metrik. Nilai yang valid: `&&`: Peringatan dipicu hanya jika semua metrik memenuhi kondisi peringatannya. Peringatan dipicu hanya jika semua ekspresi dalam `ExpressionList` bernilai true. `\|\|`: Peringatan dipicu jika salah satu metrik memenuhi kondisi peringatannya.	\|\|
ExpressionRaw	string	Kondisi peringatan yang dibuat menggunakan ekspresi. Contoh: Atur blacklist peringatan untuk resource tertentu. Contoh: `$instanceId != 'i-io8kfvcpp7x5**' && $Average > 50`. Ekspresi ini menunjukkan bahwa peringatan tidak dipicu ketika nilai `Average` untuk instans `i-io8kfvcpp7x5` lebih besar dari 50. Atur ambang batas peringatan khusus untuk instans tertentu dalam aturan. Contoh: `$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)`. Ekspresi ini menunjukkan bahwa peringatan dipicu untuk instans `i-io8kfvcpp7x5**` hanya ketika nilai `Average`-nya lebih besar dari 80. Untuk instans lain, peringatan dipicu ketika nilai `Average`-nya lebih besar dari 50. Batasi jumlah instans yang dapat memiliki nilai metrik melebihi ambang batas. Contoh: `count($Average > 20) > 3`. Ekspresi ini menunjukkan bahwa peringatan dipicu hanya ketika jumlah instans yang nilai `Average`-nya lebih besar dari 20 melebihi 3.	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)
Times	integer	Jumlah kali kondisi peringatan harus terpenuhi 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 Anda harus mengatur parameter ini hanya ketika membuat aturan peringatan Prometheus untuk Pemantauan Cloud Hibrida.
PromQL	string	Pernyataan kueri Prometheus Query Language (PromQL). Catatan Data yang dikueri menggunakan pernyataan PromQL adalah data peringatan. Sertakan ambang batas peringatan dalam pernyataan tersebut.	CpuUsage{instanceId="xxxx"}[1m]>90
Level	string	Level peringatan. Nilai yang valid: CRITICAL: critical. WARN: warning. INFO: info.	CRITICAL
Times	integer	Jumlah kali kondisi peringatan harus terpenuhi sebelum pemberitahuan peringatan dikirim.	3
Annotations	object
Annotations	array<object>	Ketika peringatan Prometheus dipicu, kunci dan nilai anotasi dirender untuk membantu Anda memahami metrik atau aturan peringatan. Catatan Fitur ini setara dengan fitur Anotasi Prometheus.
	object	Tidak ada.
Key	string	Kunci anotasi.	summary
Value	string	Nilai anotasi.	{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }
ProductCategory	string	Jenis layanan Alibaba Cloud.	slb
GmtCreate	integer	Waktu pembuatan aturan. Nilai ini berupa Stempel waktu UNIX.	1760432061000
GmtUpdate	string	Waktu pembaruan aturan. Nilai ini berupa 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}通知（${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 }} }"
              }
            ]
          }
        },
        "ProductCategory": "slb",
        "GmtCreate": 1760432061000,
        "GmtUpdate": "1760432061000"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
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.