DescribeMetricRuleList - - Alibaba Cloud Documentation Center

Kueri aturan peringatan.

Topik ini memberikan contoh cara mengkueri semua aturan peringatan dalam Akun Alibaba Cloud Anda. Hasil yang dikembalikan menunjukkan bahwa hanya satu aturan peringatan ditemukan, yaitu Rule_01 dengan ID applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Yes	DescribeMetricRuleList	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeMetricRuleList.
MetricName	String	No	cpu_total	Nama metrik. Untuk informasi tentang cara mendapatkan nama metrik, lihat DescribeMetricMetaList atau Lampiran 1: Metrik.
EnableState	Boolean	No	true	Menentukan apakah akan mengkueri aturan peringatan yang diaktifkan atau dinonaktifkan. Nilai yang valid: true: mengkueri aturan peringatan yang diaktifkan. false: mengkueri aturan peringatan yang dinonaktifkan.
Namespace	String	No	acs_ecs_dashboard	Namespace layanan cloud. Untuk informasi tentang cara mendapatkan namespace layanan cloud, lihat DescribeMetricMetaList atau Lampiran 1: Metrik.
Page	Integer	No	1	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.
PageSize	Integer	No	10	Jumlah entri per halaman. Halaman dimulai dari halaman 1. Nilai default: 10.
AlertState	String	No	OK	Status aturan peringatan. Nilai yang valid: OK: Aturan peringatan tidak memiliki peringatan aktif. ALARM: Aturan peringatan memiliki peringatan aktif. INSUFFICIENT_DATA: Tidak ada data yang tersedia.
Dimensions	String	No	{"instanceId":"i-2ze2d6j5uhg20x47****"}	Dimensi pemantauan resource yang ditentukan. Tetapkan nilainya ke kumpulan pasangan `key:value`. Contoh: `{"userId":"120886317861**"}` atau `{"instanceId":"i-2ze2d6j5uhg20x47**"}`.
RuleName	String	No	Rule_01	Nama aturan peringatan. Parameter ini mendukung fuzzy match.
GroupId	String	No	7301****	ID kelompok aplikasi. Untuk informasi tentang cara mendapatkan ID kelompok aplikasi, lihat DescribeMonitorGroups.
RuleIds	String	No	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****	ID aturan peringatan. Anda dapat menentukan hingga 20 ID sekaligus. Pisahkan beberapa ID dengan koma (,).

Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Parameter umum.

Parameter respons

Parameter	Type	Contoh	Deskripsi
Code	Integer	200	Kode status HTTP. Catatan Kode status 200 menunjukkan bahwa permintaan berhasil.
Message	String	The specified resource is not found.	Pesan kesalahan.
RequestId	String	386C6712-335F-5054-930A-CC92B851ECBA	ID permintaan.
Total	String	1	Jumlah total entri.
Success	Boolean	true	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true false
Alarms	Array of Alarm		Detail aturan peringatan.
Alarm
SilenceTime	Integer	86400	Periode bisu selama pemberitahuan peringatan baru tidak dikirim meskipun kondisi pemicu terpenuhi. Satuan: detik. Nilai default: 86400. Nilai minimum: 3600. Hanya satu peringatan yang dilaporkan selama setiap periode bisu meskipun nilai metrik melebihi ambang batas peringatan beberapa kali berturut-turut.
MetricName	String	cpu_total	Nama metrik.
Webhook	String	https://www.aliyun.com	URL callback. CloudMonitor mendorong pemberitahuan peringatan ke URL callback yang ditentukan dengan mengirim permintaan HTTP POST. Hanya protokol HTTP yang didukung.
ContactGroups	String	ECS_Alarm	Kelompok kontak peringatan.
SourceType	String	METRIC	Jenis aturan peringatan. Nilai yang valid: METRIC. Nilai ini menunjukkan aturan peringatan untuk metrik deret waktu.
Namespace	String	acs_ecs_dashboard	Namespace layanan cloud.
MailSubject	String	"${serviceType}-${metricName}-${levelDescription}Notification (${dimensions})"	Subjek email pemberitahuan peringatan.
NoEffectiveInterval	String	00:00-05:30	Periode waktu saat aturan peringatan tidak efektif.
EffectiveInterval	String	05:31-23:59	Periode waktu saat aturan peringatan efektif.
RuleName	String	Rule_01	Nama aturan peringatan.
AlertState	String	OK	Status aturan peringatan. Nilai yang valid: OK: Aturan peringatan tidak memiliki peringatan aktif. ALARM: Aturan peringatan memiliki peringatan aktif. INSUFFICIENT_DATA: Tidak ada data yang tersedia.
Period	String	60	Periode statistik.
RuleId	String	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****	ID aturan peringatan.
GroupName	String	ECS_Group	Nama kelompok aplikasi. Catatan Jika aturan peringatan dikaitkan dengan kelompok aplikasi, nama kelompok aplikasi dikembalikan dalam parameter ini.
GroupId	String	7301****	ID kelompok aplikasi.
Dimensions	String	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]	Dimensi aturan peringatan.
EnableState	Boolean	true	Menunjukkan apakah aturan peringatan diaktifkan. Nilai yang valid: true: Aturan peringatan diaktifkan. false: Aturan peringatan dinonaktifkan.
Resources	String	[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]	Resource yang dikaitkan dengan aturan peringatan.
Escalations	Object		Kondisi untuk memicu peringatan tingkat berbeda.
Info	Object		Kondisi untuk memicu peringatan tingkat Info.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	Operator perbandingan yang digunakan untuk membandingkan nilai metrik dengan ambang batas untuk peringatan tingkat Info. Nilai yang valid: GreaterThanOrEqualToThreshold: lebih besar dari atau sama dengan ambang batas GreaterThanThreshold: lebih besar dari ambang batas LessThanOrEqualToThreshold: kurang dari atau sama dengan ambang batas LessThanThreshold: kurang dari ambang batas NotEqualToThreshold: tidak sama dengan ambang batas GreaterThanYesterday: lebih besar dari nilai metrik pada waktu yang sama kemarin LessThanYesterday: kurang dari nilai metrik pada waktu yang sama kemarin GreaterThanLastWeek: lebih besar dari nilai metrik pada waktu yang sama minggu lalu LessThanLastWeek: kurang dari nilai metrik pada waktu yang sama minggu lalu GreaterThanLastPeriod: lebih besar dari nilai metrik dalam siklus pemantauan terakhir LessThanLastPeriod: kurang dari nilai metrik dalam siklus pemantauan terakhir
PreCondition	String	$Average>80	Kondisi tambahan untuk memicu peringatan tingkat Info. Kondisi tambahan ini berlaku ketika nilai parameter ComparisonOperator adalah GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod, atau LessThanLastPeriod. Sebagai contoh, nilai parameter PreCondition, ComparisonOperator, dan Threshold diatur masing-masing ke $Average>80, GreaterThanYesterday, dan 10. Peringatan dipicu hanya jika nilai metrik rata-rata lebih besar dari 80 dan 10% lebih besar dari nilai metrik rata-rata pada waktu yang sama kemarin. Catatan $Average adalah placeholder yang terdiri dari `tanda dolar ($) dan metode statistik`. CloudMonitor mengganti placeholder tersebut dengan nilai agregat atau nilai asli sebelum perbandingan nilai.
Times	Integer	3	Jumlah berturut-turut kali nilai metrik memenuhi kondisi peringatan sebelum peringatan tingkat Info dipicu.
Threshold	String	90	Ambang batas untuk peringatan tingkat Info.
Statistics	String	Average	Metode statistik untuk peringatan tingkat Info.
Warn	Object		Kondisi untuk memicu peringatan tingkat Warn.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	Operator perbandingan yang digunakan untuk membandingkan nilai metrik dengan ambang batas untuk peringatan tingkat Warn. Nilai yang valid: GreaterThanOrEqualToThreshold: lebih besar dari atau sama dengan ambang batas GreaterThanThreshold: lebih besar dari ambang batas LessThanOrEqualToThreshold: kurang dari atau sama dengan ambang batas LessThanThreshold: kurang dari ambang batas NotEqualToThreshold: tidak sama dengan ambang batas GreaterThanYesterday: lebih besar dari nilai metrik pada waktu yang sama kemarin LessThanYesterday: kurang dari nilai metrik pada waktu yang sama kemarin GreaterThanLastWeek: lebih besar dari nilai metrik pada waktu yang sama minggu lalu LessThanLastWeek: kurang dari nilai metrik pada waktu yang sama minggu lalu GreaterThanLastPeriod: lebih besar dari nilai metrik dalam siklus pemantauan terakhir LessThanLastPeriod: kurang dari nilai metrik dalam siklus pemantauan terakhir
PreCondition	String	$Average>80	Kondisi tambahan untuk memicu peringatan tingkat Warn. Kondisi tambahan ini berlaku ketika nilai parameter ComparisonOperator adalah GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod, atau LessThanLastPeriod. Sebagai contoh, nilai parameter PreCondition, ComparisonOperator, dan Threshold diatur masing-masing ke $Average>80, GreaterThanYesterday, dan 10. Peringatan dipicu hanya jika nilai metrik rata-rata lebih besar dari 80 dan 10% lebih besar dari nilai metrik rata-rata pada waktu yang sama kemarin. Catatan $Average adalah placeholder yang terdiri dari `tanda dolar ($) dan metode statistik`. CloudMonitor mengganti placeholder tersebut dengan nilai agregat atau nilai asli sebelum perbandingan nilai.
Times	Integer	3	Jumlah berturut-turut kali nilai metrik memenuhi kondisi peringatan sebelum peringatan tingkat Warn dipicu.
Threshold	String	90	Ambang batas untuk peringatan tingkat Warn.
Statistics	String	Average	Metode statistik untuk peringatan tingkat Warn.
Critical	Object		Kondisi untuk memicu peringatan tingkat Critical.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	Operator perbandingan yang digunakan untuk membandingkan nilai metrik dengan ambang batas untuk peringatan tingkat Critical. Nilai yang valid: GreaterThanOrEqualToThreshold: lebih besar dari atau sama dengan ambang batas GreaterThanThreshold: lebih besar dari ambang batas LessThanOrEqualToThreshold: kurang dari atau sama dengan ambang batas LessThanThreshold: kurang dari ambang batas NotEqualToThreshold: tidak sama dengan ambang batas GreaterThanYesterday: lebih besar dari nilai metrik pada waktu yang sama kemarin LessThanYesterday: kurang dari nilai metrik pada waktu yang sama kemarin GreaterThanLastWeek: lebih besar dari nilai metrik pada waktu yang sama minggu lalu LessThanLastWeek: kurang dari nilai metrik pada waktu yang sama minggu lalu GreaterThanLastPeriod: lebih besar dari nilai metrik dalam siklus pemantauan terakhir LessThanLastPeriod: kurang dari nilai metrik dalam siklus pemantauan terakhir
PreCondition	String	$Average>80	Kondisi tambahan untuk memicu peringatan tingkat Critical. Kondisi tambahan ini berlaku ketika nilai parameter ComparisonOperator adalah GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod, atau LessThanLastPeriod. Sebagai contoh, nilai parameter PreCondition, ComparisonOperator, dan Threshold diatur masing-masing ke $Average>80, GreaterThanYesterday, dan 10. Peringatan dipicu hanya jika nilai metrik rata-rata lebih besar dari 80 dan 10% lebih besar dari nilai metrik rata-rata pada waktu yang sama kemarin. Catatan $Average adalah placeholder yang terdiri dari `tanda dolar ($) dan metode statistik`. CloudMonitor mengganti placeholder tersebut dengan nilai agregat atau nilai asli sebelum perbandingan nilai.
Times	Integer	3	Jumlah berturut-turut kali nilai metrik memenuhi kondisi peringatan sebelum peringatan tingkat Critical dipicu.
Threshold	String	90	Ambang batas untuk peringatan tingkat Critical.
Statistics	String	Average	Metode statistik untuk peringatan tingkat Critical.
NoDataPolicy	String	KEEP_LAST_STATE	Metode yang digunakan untuk menangani peringatan saat tidak ditemukan data pemantauan. Nilai yang valid: KEEP_LAST_STATE (default): Tidak ada tindakan yang dilakukan. INSUFFICIENT_DATA: Peringatan dengan konten "Insufficient data" dipicu. OK: Status dianggap normal.
CompositeExpression	Object		Kondisi pemicu untuk beberapa metrik. Catatan Kondisi pemicu untuk satu metrik dan beberapa metrik saling eksklusif. Anda tidak dapat menentukan kondisi pemicu untuk satu metrik dan beberapa metrik secara bersamaan.
Level	String	Critical	Tingkat peringatan. Nilai yang valid: Critical Warn Info
ExpressionList	Array of ExpressionList		Kondisi pemicu yang dibuat dalam mode standar.
ExpressionList
MetricName	String	cpu_total	Metrik yang digunakan untuk memantau layanan cloud.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	Operator perbandingan yang digunakan untuk membandingkan nilai metrik dengan ambang batas. Nilai yang valid: GreaterThanOrEqualToThreshold: lebih besar dari atau sama dengan ambang batas GreaterThanThreshold: lebih besar dari ambang batas LessThanOrEqualToThreshold: kurang dari atau sama dengan ambang batas LessThanThreshold: kurang dari ambang batas NotEqualToThreshold: tidak sama dengan ambang batas GreaterThanYesterday: lebih besar dari nilai metrik pada waktu yang sama kemarin LessThanYesterday: kurang dari nilai metrik pada waktu yang sama kemarin GreaterThanLastWeek: lebih besar dari nilai metrik pada waktu yang sama minggu lalu LessThanLastWeek: kurang dari nilai metrik pada waktu yang sama minggu lalu GreaterThanLastPeriod: lebih besar dari nilai metrik dalam siklus pemantauan terakhir LessThanLastPeriod: kurang dari nilai metrik dalam siklus pemantauan terakhir
Statistics	String	$Maximum	Metode statistik metrik. Nilai yang valid: $Maximum: nilai maksimum $Minimum: nilai minimum $Average: nilai rata-rata $Availability: laju ketersediaan (biasanya digunakan untuk Pemantauan situs) Catatan `$` adalah awalan metrik. Untuk informasi tentang layanan Alibaba Cloud yang didukung oleh CloudMonitor, lihat Lampiran 1: Metrik.
Threshold	String	90	Ambang batas peringatan.
Period	Integer	60	Periode agregasi metrik. Satuan: detik.
ExpressionListJoin	String	\|\|	Hubungan antara kondisi pemicu untuk beberapa metrik. Nilai yang valid: `&&`: Peringatan dipicu hanya jika semua metrik memenuhi kondisi pemicu. Peringatan dipicu hanya jika hasil semua ekspresi yang ditentukan dalam parameter ExpressionList adalah `true`. `\|\|`: Peringatan dipicu jika salah satu metrik memenuhi kondisi pemicu.
ExpressionRaw	String	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)	Kondisi pemicu yang dibuat menggunakan ekspresi. Anda dapat menggunakan ekspresi untuk membuat kondisi pemicu dalam skenario berikut: Tetapkan blacklist peringatan untuk resource tertentu. Misalnya, jika Anda menentukan `$instanceId != 'i-io8kfvcpp7x5**'` `&&` `$Average > 50`, tidak ada peringatan yang dihasilkan meskipun `nilai metrik rata-rata` instans `i-io8kfvcpp7x5` melebihi 50. Tetapkan ambang batas peringatan khusus untuk instans tertentu dalam aturan. Misalnya, jika Anda menentukan `$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)`, peringatan dipicu ketika `nilai metrik rata-rata` instans `i-io8kfvcpp7x5**` melebihi 80 atau `nilai metrik rata-rata` instans lain melebihi 50. Batasi jumlah instans yang nilai metriknya melebihi ambang batas. Misalnya, jika Anda menentukan `count($Average > 20) > 3`, peringatan dipicu hanya jika jumlah instans yang `nilai metrik rata-rata`-nya melebihi 20 lebih dari tiga.
Times	Integer	3	Jumlah pemicu berturut-turut. Jika jumlah kali nilai metrik memenuhi kondisi pemicu mencapai nilai parameter ini, CloudMonitor mengirim pemberitahuan peringatan.
Labels	Array of Labels		Tag aturan peringatan.
Labels
Key	String	cmsRuleKey	Kunci tag aturan peringatan.
Value	String	cmsRuleValue	Nilai tag aturan peringatan.
Prometheus	Object		Aturan peringatan Prometheus. Catatan Parameter ini wajib hanya saat Anda membuat aturan peringatan Prometheus untuk Pemantauan Cloud Hibrida.
PromQL	String	CpuUsage{instanceId="xxxx"}[1m]>90	Pernyataan kueri PromQL. Catatan Data yang diperoleh menggunakan pernyataan kueri PromQL adalah data pemantauan. Anda harus menyertakan ambang batas peringatan dalam pernyataan ini.
Level	String	Critical	Tingkat peringatan. Nilai yang valid: Critical Warn Info
Times	Long	3	Jumlah pemicu berturut-turut. Jika jumlah kali nilai metrik memenuhi kondisi pemicu mencapai nilai parameter ini, CloudMonitor mengirim pemberitahuan peringatan.
Annotations	Array of Annotations		Anotasi aturan peringatan Prometheus. Saat peringatan Prometheus dipicu, sistem merender kunci dan nilai yang dianotasi untuk membantu Anda memahami metrik dan aturan peringatan. Catatan Parameter ini setara dengan parameter annotations pada Prometheus open source.
Annotations
Key	String	summary	Kunci anotasi.
Value	String	{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }	Nilai anotasi.

Contoh

Permintaan contoh

http(s)://[Endpoint]/?Action=DescribeMetricRuleList
&<Common request parameters>

Respons sukses contoh

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMetricRuleListResponse>
	<RequestId>386C6712-335F-5054-930A-CC92B851ECBA</RequestId>
	<Total>1</Total>
	<Alarms>
		<Alarm>
			<GroupName>ECS_Group</GroupName>
			<SilenceTime>86400</SilenceTime>
			<ContactGroups>ECS_Alarm</ContactGroups>
			<NoEffectiveInterval>00:00-05:30</NoEffectiveInterval>
			<GroupBy>group</GroupBy>
			<MailSubject>${serviceType}-${metricName}-${levelDescription}Notification(${dimensions})</MailSubject>
			<SourceType>METRIC</SourceType>
			<RuleId>applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****</RuleId>
			<Period>60</Period>
			<Dimensions>
				<instanceId>i-2ze2d6j5uhg20x47****</instanceId>
			</Dimensions>
			<EffectiveInterval>05:31-23:59</EffectiveInterval>
			<Namespace>acs_ecs_dashboard</Namespace>
			<AlertState>OK</AlertState>
			<GroupId>7301****</GroupId>
			<MetricName>cpu_total</MetricName>
			<EnableState>true</EnableState>
			<Escalations>
				<Critical>
					<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>
					<Times>3</Times>
					<Statistics>Average</Statistics>
					<Threshold>90</Threshold>
				</Critical>
				<Info>
					<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>
					<Times>3</Times>
					<Statistics>Average</Statistics>
					<Threshold>90</Threshold>
				</Info>
				<Warn>
					<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>
					<Times>3</Times>
					<Statistics>Average</Statistics>
					<Threshold>90</Threshold>
				</Warn>
			</Escalations>
			<Webhook>https://www.aliyun.com</Webhook>
			<Resources>[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]</Resources>
			<RuleName>Rule_01</RuleName>
		</Alarm>
	</Alarms>
	<Code>200</Code>
	<Success>true</Success>
</DescribeMetricRuleListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "386C6712-335F-5054-930A-CC92B851ECBA",
  "Total" : 1,
  "Alarms" : {
    "Alarm" : [ {
      "GroupName" : "ECS_Group",
      "SilenceTime" : 86400,
      "ContactGroups" : "ECS_Alarm",
      "NoEffectiveInterval" : "00:00-05:30",
      "GroupBy" : "group",
      "MailSubject": "${serviceType}-${metricName}-${levelDescription}Notification(${dimensions})",
      "SourceType" : "METRIC",
      "RuleId" : "applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****",
      "Period" : 60,
      "Dimensions" : [ {
        "instanceId" : "i-2ze2d6j5uhg20x47****"
      } ],
      "EffectiveInterval" : "05:31-23:59",
      "Namespace" : "acs_ecs_dashboard",
      "AlertState" : "OK",
      "GroupId" : "7301****",
      "MetricName" : "cpu_total",
      "EnableState" : true,
      "Escalations" : {
        "Critical" : {
          "ComparisonOperator" : "GreaterThanOrEqualToThreshold",
          "Times" : 3,
          "Statistics" : "Average",
          "Threshold" : "90"
        },
        "Info" : {
          "ComparisonOperator" : "GreaterThanOrEqualToThreshold",
          "Times" : 3,
          "Statistics" : "Average",
          "Threshold" : "90"
        },
        "Warn" : {
          "ComparisonOperator" : "GreaterThanOrEqualToThreshold",
          "Times" : 3,
          "Statistics" : "Average",
          "Threshold" : "90"
        }
      },
      "Webhook" : "https://www.aliyun.com",
      "Resources" : "[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]",
      "RuleName" : "Rule_01"
    } ]
  },
  "Code" : "200",
  "Success" : true
}

Kode kesalahan

Kode status HTTP	Kode kesalahan	Pesan kesalahan	Deskripsi
404	ResourceNotFound	The specified resource is not found.	Resource yang ditentukan tidak ditemukan.

Untuk daftar kode kesalahan, lihat Kode kesalahan layanan.