DescribeMetricRuleList - - Alibaba Cloud Dokümantasyon Merkezi

Uyarı kuralı listesindeki tüm kuralları sorgular.

Operation description

Bu konu, geçerli Alibaba Cloud hesabındaki uyarı kuralı listesinde yer alan tüm uyarı kurallarının nasıl sorgulanacağına ilişkin bir örnek sunmaktadır. Yanıt, uyarı kuralı listesinin yalnızca bir uyarı kuralı içerdiğini gösterir. Uyarı kuralının adı Rule_01, kimliği ise applyTemplate344cfd42-0f32-4fd6-805a-88d7908a**** olarak verilmiştir.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeMetricRuleList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MetricName	string	No	Metrik adı. Metrik adlarının nasıl alınacağı hakkında bilgi için DescribeMetricMetaList veya Bulut hizmeti metrikleri konularına bakın. Not: Bileşik metrikler için yalnızca ilk metriğe göre arama yapabilirsiniz.	cpu_total
EnableState	boolean	No	Uyarı kuralının etkinlik durumu. Geçerli değerler: true: Etkin. false: Devre dışı.	true
Namespace	string	No	Bulut hizmetinin ad alanı. Bir bulut hizmetinin ad alanının nasıl alınacağı hakkında bilgi için DescribeMetricMetaList veya Bulut hizmeti metrikleri konularına bakın.	acs_ecs_dashboard
Page	integer	No	Sayfa numarası. Minimum değer: 1. Varsayılan değer: 1.	1
PageSize	integer	No	Sayfa başına giriş sayısı. Minimum değer: 1. Varsayılan değer: 10.	10
AlertState	string	No	Uyarı kuralının durumu. Geçerli değerler: OK: Normal. ALARM: Uyarı. INSUFFICIENT_DATA: Veri yok.	OK
Dimensions	string	No	Belirtilen kaynağın izleme boyutları. Biçim: anahtar:değer çiftlerinden oluşan bir koleksiyon, örneğin {"userId":"120886317861**"} ve {"instanceId":"i-2ze2d6j5uhg20x47**"}.	{"instanceId":"i-2ze2d6j5uhg20x47****"}
RuleName	string	No	Uyarı kuralının adı. Bu parametre bulanık aramayı destekler.	Rule_01
GroupId	string	No	Uygulama grubunun kimliği. Uygulama grubu kimliğinin nasıl alınacağı hakkında bilgi için DescribeMonitorGroups konusuna bakın.	7301****
RuleIds	string	No	Uyarı kurallarının kimlikleri. Birden fazla kimliği virgül (,) ile ayırın. Tek seferde en fazla 20 uyarı kuralını sorgulayabilirsiniz.	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****

Ortak istek parametreleri hakkında daha fazla bilgi için Ortak parametreler konusuna bakın.

Response elements

Element	Type	Description	Example
	object	Yok.
Code	integer	HTTP durum kodu. Not 200 başarılı olduğunu gösterir.	200
Message	string	Hata mesajı.	The specified resource is not found.
RequestId	string	İstek kimliği.	386C6712-335F-5054-930A-CC92B851ECBA
Total	string	Toplam kayıt sayısı.	1
Success	boolean	İşlemin başarılı olup olmadığını gösterir. Geçerli değerler: true: Başarılı. false: Başarısız.	true
Alarms	object
Alarm	array<object>	Uyarı kuralları listesi.
	array<object>	Yok.
SilenceTime	integer	Sessize alma süresi. Birim: saniye. Varsayılan değer: 86400. Minimum değer: 3600. İzleme verileri uyarı kuralı eşiğini sürekli olarak aştığında, her sessize alma süresi içinde yalnızca bir uyarı bildirimi gönderilir.	86400
MetricName	string	Metrik adı.	cpu_total
Webhook	string	Bir uyarı tetiklendiğinde geri çağırma URL'si. CloudMonitor, uyarı bilgilerini bir POST isteği aracılığıyla bu URL'ye gönderir. Şu anda yalnızca HTTP protokolü desteklenmektedir.	https://www.aliyun.com
ContactGroups	string	Uyarı kişi grubu.	ECS_Alarm
SourceType	string	Uyarı kuralının türü. Geçerli değer: Zaman serisi metrik uyarı kuralını belirten METRIC.	METRIC
Namespace	string	Bulut hizmetinin ad alanı.	acs_ecs_dashboard
MailSubject	string	Uyarı e-postasının konusu.	"${serviceType}-${metricName}-${levelDescription} notification(${dimensions})"
NoEffectiveInterval	string	Uyarı kuralının geçersiz olduğu zaman aralığı.	00:00-05:30
EffectiveInterval	string	Uyarı kuralının geçerli olduğu zaman aralığı.	05:31-23:59
RuleName	string	Uyarı kuralının adı.	Rule_01
AlertState	string	Uyarı kuralının durumu. Geçerli değerler: OK: Normal. ALARM: Uyarı. INSUFFICIENT_DATA: Veri yok.	OK
Period	string	Toplama dönemi.	60
RuleId	string	Uyarı kuralının kimliği.	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****
GroupName	string	Uygulama grubunun adı. Not Bu parametre, uyarı kuralı bir uygulama grubuyla ilişkilendirilmişse görüntülenir.	ECS_Group
GroupId	string	Uygulama grubunun kimliği.	7301****
Dimensions	string	Uyarı kuralının boyutları.	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]
EnableState	boolean	Etkinlik durumu. Geçerli değerler: true: Etkin. false: Devre dışı.	true
Resources	string	Uyarı kuralıyla ilişkilendirilen kaynaklar.	[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]
Escalations	object	Önem düzeyine göre uyarılar için tetikleme koşulları.
Info	object	Info düzeyindeki uyarıların tetikleme koşulları.
ComparisonOperator	string	Info düzeyindeki eşikler için karşılaştırma operatörü. Geçerli değerler: GreaterThanOrEqualToThreshold: büyük veya eşit. GreaterThanThreshold: büyük. LessThanOrEqualToThreshold: küçük veya eşit. LessThanThreshold: küçük. NotEqualToThreshold: eşit değil. GreaterThanYesterday: dünün aynı saatine kıyasla yıldan yıla artış. LessThanYesterday: dünün aynı saatine kıyasla yıldan yıla azalış. GreaterThanLastWeek: geçen haftanın aynı saatine kıyasla yıldan yıla artış. LessThanLastWeek: geçen haftanın aynı saatine kıyasla yıldan yıla azalış. GreaterThanLastPeriod: önceki döneme kıyasla dönemden döneme artış. LessThanLastPeriod: önceki döneme kıyasla dönemden döneme azalış.	GreaterThanOrEqualToThreshold
PreCondition	string	Info düzeyindeki uyarılar için ön koşul. ComparisonOperator parametresi yıldan yıla veya dönemden döneme karşılaştırma olarak ayarlandığında, bu parametre onunla birlikte çalışır. Örneğin, bu parametre $Average>80, ComparisonOperator GreaterThanYesterday ve Threshold 10 olarak ayarlanırsa, ortalama değer 80'den büyük olduğunda ve değer dünküne kıyasla %10 arttığında bir uyarı tetiklenir. Not $Average>0 içindeki $Average, $monitoring_result_field_value biçiminde bir yer tutucudur. CloudMonitor bunu karşılık gelen istatistiksel değerle veya orijinal izleme değeriyle değiştirir.	$Average>80
Times	integer	Info düzeyindeki uyarı koşulunun karşılandığı ardışık kez sayısı. Uyarı, koşul yalnızca belirtilen ardışık kez karşılandığında ve eşik aşıldığında tetiklenir.	3
Threshold	string	Info düzeyindeki uyarılar için eşik.	90
Statistics	string	Info düzeyindeki uyarılar için istatistiksel yöntem.	Average
Warn	object	Warn düzeyindeki uyarıların tetikleme koşulları.
ComparisonOperator	string	Warn düzeyindeki eşikler için karşılaştırma operatörü. Geçerli değerler: GreaterThanOrEqualToThreshold: büyük veya eşit. GreaterThanThreshold: büyük. LessThanOrEqualToThreshold: küçük veya eşit. LessThanThreshold: küçük. NotEqualToThreshold: eşit değil. GreaterThanYesterday: dünün aynı saatine kıyasla yıldan yıla artış. LessThanYesterday: dünün aynı saatine kıyasla yıldan yıla azalış. GreaterThanLastWeek: geçen haftanın aynı saatine kıyasla yıldan yıla artış. LessThanLastWeek: geçen haftanın aynı saatine kıyasla yıldan yıla azalış. GreaterThanLastPeriod: önceki döneme kıyasla dönemden döneme artış. LessThanLastPeriod: önceki döneme kıyasla dönemden döneme azalış.	GreaterThanOrEqualToThreshold
PreCondition	string	Warn düzeyindeki uyarılar için ön koşul. ComparisonOperator parametresi yıldan yıla veya dönemden döneme karşılaştırma olarak ayarlandığında, bu parametre onunla birlikte çalışır. Örneğin, bu parametre $Average>80, ComparisonOperator GreaterThanYesterday ve Threshold 10 olarak ayarlanırsa, ortalama değer 80'den büyük olduğunda ve değer dünküne kıyasla %10 arttığında bir uyarı tetiklenir. Not $Average>0 içindeki $Average, $monitoring_result_field_value biçiminde bir yer tutucudur. CloudMonitor bunu karşılık gelen istatistiksel değerle veya orijinal izleme değeriyle değiştirir.	$Average>80
Times	integer	Warn düzeyindeki uyarı koşulunun karşılandığı ardışık kez sayısı. Uyarı, koşul yalnızca belirtilen ardışık kez karşılandığında ve eşik aşıldığında tetiklenir.	3
Threshold	string	Warn düzeyindeki uyarılar için eşik.	90
Statistics	string	Warn düzeyindeki uyarılar için istatistiksel yöntem.	Average
Critical	object	Critical düzeyindeki uyarıların tetikleme koşulları.
ComparisonOperator	string	Critical düzeyindeki eşikler için karşılaştırma operatörü. Geçerli değerler: GreaterThanOrEqualToThreshold: büyük veya eşit. GreaterThanThreshold: büyük. LessThanOrEqualToThreshold: küçük veya eşit. LessThanThreshold: küçük. NotEqualToThreshold: eşit değil. GreaterThanYesterday: dünün aynı saatine kıyasla yıldan yıla artış. LessThanYesterday: dünün aynı saatine kıyasla yıldan yıla azalış. GreaterThanLastWeek: geçen haftanın aynı saatine kıyasla yıldan yıla artış. LessThanLastWeek: geçen haftanın aynı saatine kıyasla yıldan yıla azalış. GreaterThanLastPeriod: önceki döneme kıyasla dönemden döneme artış. LessThanLastPeriod: önceki döneme kıyasla dönemden döneme azalış.	GreaterThanOrEqualToThreshold
PreCondition	string	Critical düzeyindeki uyarılar için ön koşul. ComparisonOperator parametresi yıldan yıla veya dönemden döneme karşılaştırma olarak ayarlandığında, bu parametre onunla birlikte çalışır. Örneğin, bu parametre $Average>80, ComparisonOperator GreaterThanYesterday ve Threshold 10 olarak ayarlanırsa, ortalama değer 80'den büyük olduğunda ve değer dünküne kıyasla %10 arttığında bir uyarı tetiklenir. Not $Average>0 içindeki $Average, `$monitoring_result_field_value` biçiminde bir yer tutucudur. CloudMonitor bunu karşılık gelen istatistiksel değerle veya orijinal izleme değeriyle değiştirir.	$Average>80
Times	integer	Critical düzeyindeki uyarı koşulunun karşılandığı ardışık kez sayısı. Uyarı, koşul yalnızca belirtilen ardışık kez karşılandığında ve eşik aşıldığında tetiklenir.	3
Threshold	string	Critical düzeyindeki uyarılar için eşik.	90
Statistics	string	Critical düzeyindeki uyarılar için istatistiksel yöntem.	Average
NoDataPolicy	string	İzleme verisi bulunamadığında uyarıları işleme yöntemi. Geçerli değerler: KEEP_LAST_STATE (varsayılan): Herhangi bir işlem yapılmaz. INSUFFICIENT_DATA: Uyarı içeriği veri olmadığını belirtir. OK: Normal.	KEEP_LAST_STATE
CompositeExpression	object	Birden fazla metrik için uyarı koşulları. Not Tek metrikli ve çok metrikli koşullar birbirini dışlar ve aynı anda ayarlanamaz.
Level	string	Uyarı düzeyi. Geçerli değerler: CRITICAL: Kritik. WARN: Uyarı. INFO: Bilgi.	CRITICAL
ExpressionList	object
ExpressionList	array<object>	Standart modda oluşturulan uyarı koşullarının listesi.
	object	Yok.
MetricName	string	Bulut hizmetinin metrik adı.	cpu_total
Period	integer	Metriğin toplama dönemi. Birim: saniye.	60
Statistics	string	Metriğin istatistiksel yöntemi. Geçerli değerler: $Maximum: Maksimum değer. $Minimum: Minimum değer. $Average: Ortalama değer. $Availability: Kullanılabilirlik (genellikle site izleme için kullanılır). Not `$`, metrikler için birleşik ön ektir. Desteklenen bulut hizmetleri için Bulut hizmeti metrikleri konusuna bakın.	$Maximum
ComparisonOperator	string	Eşik için karşılaştırma operatörü. Geçerli değerler: GreaterThanOrEqualToThreshold: büyük veya eşit. GreaterThanThreshold: büyük. LessThanOrEqualToThreshold: küçük veya eşit. LessThanThreshold: küçük. NotEqualToThreshold: eşit değil. GreaterThanYesterday: dünün aynı saatine kıyasla yıldan yıla artış. LessThanYesterday: dünün aynı saatine kıyasla yıldan yıla azalış. GreaterThanLastWeek: geçen haftanın aynı saatine kıyasla yıldan yıla artış. LessThanLastWeek: geçen haftanın aynı saatine kıyasla yıldan yıla azalış. GreaterThanLastPeriod: önceki döneme kıyasla dönemden döneme artış. LessThanLastPeriod: önceki döneme kıyasla dönemden döneme azalış.	GreaterThanOrEqualToThreshold
Threshold	string	Uyarı eşiği.	90
ExpressionListJoin	string	Çok metrikli uyarı koşulları arasındaki ilişki. Geçerli değerler: `&&`: Yalnızca tüm metrikler uyarı koşullarını karşıladığında bir uyarı tetiklenir. Yalnızca ExpressionList içindeki tüm ifadeler `true` olduğunda bir uyarı tetiklenir. `\|\|`: Metriklerden herhangi biri uyarı koşulunu karşıladığında bir uyarı tetiklenir.	\|\|
ExpressionRaw	string	İfadeler kullanılarak oluşturulan uyarı koşulları. Aşağıdaki senaryolar dahil edilir ancak bunlarla sınırlı değildir: Bazı kaynaklar için bir uyarı engelleme listesi ayarlayın. Örneğin, `$instanceId != 'i-io8kfvcpp7x5**'` `&&` `$Average > 50`, uyarı kuralındaki `i-io8kfvcpp7x5` örneğinin `Average` değeri 50'yi aşsa bile uyarı tetiklenmeyeceğini belirtir. Kuraldaki belirli bir örnek için özel bir uyarı eşiği ayarlayın. Örneğin, `$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)`, yalnızca `i-io8kfvcpp7x5**` örneğinin `Average` değeri 80'i aştığında bir uyarı tetikleneceğini ve diğer örneklerin `Average` değeri 50'yi aştığında bir uyarı tetikleneceğini belirtir. Kuralda eşiği aşan örnek sayısını sınırlayın. Örneğin, `count($Average > 20) > 3`, yalnızca `Average` değeri 20'yi aşan örnek sayısı 3'ten büyük olduğunda bir uyarı tetikleneceğini belirtir.	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)
Times	integer	Uyarı bildirimi gönderilmeden önce uyarı koşulunun karşılanması gereken kez sayısı.	3
Labels	object
Labels	array<object>	Uyarı kuralının etiketleri.
	object	Yok.
Key	string	Uyarı kuralının etiket anahtarı.	cmsRuleKey
Value	string	Uyarı kuralının etiket değeri.	cmsRuleValue
Prometheus	object	Prometheus uyarıları. Not Bu parametre yalnızca Enterprise Cloud Monitor için Prometheus uyarı kuralları oluşturduğunuzda gereklidir.
PromQL	string	PromQL sorgu ifadesi. Not PromQL sorgu ifadesi tarafından elde edilen veriler uyarı verileridir. İfadeye uyarı eşiğini dahil edin.	CpuUsage{instanceId="xxxx"}[1m]>90
Level	string	Uyarı düzeyi. Geçerli değerler: CRITICAL: Kritik. WARN: Uyarı. INFO: Bilgi.	CRITICAL
Times	integer	Uyarı bildirimi gönderilmeden önce uyarı koşulunun karşılanması gereken kez sayısı.	3
Annotations	object
Annotations	array<object>	Prometheus uyarıları tetiklendiğinde, metrikleri veya uyarı kurallarını anlamanızı kolaylaştırmak için ek açıklama anahtarları ve değerleri işlenir. Not Bu özellik, Prometheus Ek Açıklamalarına eşdeğerdir.
	object	Yok.
Key	string	Ek açıklama anahtarı.	summary
Value	string	Ek açıklama değeri.	{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }
SendOK	boolean	Kurtarma uyarılarının devre dışı bırakılıp bırakılmayacağını belirtir. Geçerli değerler: true (evet) ve false (hayır).	true
ProductCategory	string	Bulut hizmetinin türü.	slb
GmtCreate	integer	Kuralın oluşturulduğu zaman. Değer bir Unix zaman damgasıdır.	1760432061000
GmtUpdate	string	Kuralın en son güncellendiği zaman. Değer bir Unix zaman damgasıdır.	1760432061000

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.	Parameter error
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.	The specified resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.