DescribeMetricRuleList - - Centre de documentation Alibaba Cloud

Cette rubrique présente un exemple illustrant comment interroger toutes les règles d'alerte associées à votre compte Alibaba Cloud. Le résultat renvoyé indique qu'une seule règle d'alerte a été trouvée. Le nom de la règle d'alerte est Rule_01 et son identifiant est applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeMetricRuleList	L'opération à effectuer. Définissez la valeur sur DescribeMetricRuleList.
MetricName	String	No	cpu_total	Le nom de la métrique. Pour savoir comment obtenir le nom d'une métrique, consultez DescribeMetricMetaList ou Annexe 1 : Métriques.
EnableState	Boolean	No	true	Indique si vous souhaitez interroger les règles d'alerte activées ou désactivées. Valeurs valides : true : interroge les règles d'alerte activées. false : interroge les règles d'alerte désactivées.
Namespace	String	No	acs_ecs_dashboard	Le namespace du service cloud. Pour savoir comment obtenir le namespace d'un service cloud, consultez DescribeMetricMetaList ou Annexe 1 : Métriques.
Page	Integer	No	1	Le numéro de page. La numérotation des pages commence à 1. Valeur par défaut : 1.
PageSize	Integer	No	10	Le nombre d'entrées par page. La numérotation des pages commence à 1. Valeur par défaut : 10.
AlertState	String	No	OK	L'état de la règle d'alerte. Valeurs valides : OK : La règle d'alerte ne comporte aucune alerte active. ALARM : La règle d'alerte comporte des alertes actives. INSUFFICIENT_DATA : Aucune donnée n'est disponible.
Dimensions	String	No	{"instanceId":"i-2ze2d6j5uhg20x47****"}	Les dimensions de surveillance de la ressource spécifiée. Définissez la valeur sur une collection de paires `key:value`. Exemple : `{"userId":"120886317861"}` ou `{"instanceId":"i-2ze2d6j5uhg20x47"}`.
RuleName	String	No	Rule_01	Le nom de la règle d'alerte. Ce paramètre prend en charge la correspondance floue.
GroupId	String	No	7301****	L'ID du groupe d'applications. Pour savoir comment obtenir l'ID d'un groupe d'applications, consultez DescribeMonitorGroups.
RuleIds	String	No	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****	L'ID de la règle d'alerte. Vous pouvez spécifier jusqu'à 20 ID à la fois. Séparez plusieurs ID par des virgules (,).

Pour plus d'informations sur les paramètres de requête communs, consultez Paramètres communs.

Paramètres de réponse

Parameter	Type	Example	Description
Code	Integer	200	Le code d'état HTTP. Remarque Le code d'état 200 indique que la requête a abouti.
Message	String	The specified resource is not found.	Le message d'erreur.
RequestId	String	386C6712-335F-5054-930A-CC92B851ECBA	L'ID de la requête.
Total	String	1	Le nombre total d'entrées.
Success	Boolean	true	Indique si la requête a abouti. Valeurs valides : true false
Alarms	Array of Alarm		Les détails des règles d'alerte.
Alarm
SilenceTime	Integer	86400	La période de silence pendant laquelle aucune nouvelle notification d'alerte n'est envoyée, même si les conditions de déclenchement sont remplies. Unité : secondes. Valeur par défaut : 86400. Valeur minimale : 3600. Une seule alerte est signalée pendant chaque période de silence, même si la valeur de la métrique dépasse plusieurs fois de suite le seuil d'alerte.
MetricName	String	cpu_total	Le nom de la métrique.
Webhook	String	https://www.aliyun.com	L'URL de rappel. CloudMonitor envoie une notification d'alerte à l'URL de rappel spécifiée en envoyant une requête HTTP POST. Seul le protocole HTTP est pris en charge.
ContactGroups	String	ECS_Alarm	Les groupes de contacts d'alerte.
SourceType	String	METRIC	Le type de la règle d'alerte. Valeur valide : METRIC. Cette valeur indique une règle d'alerte pour les métriques de séries temporelles.
Namespace	String	acs_ecs_dashboard	Le namespace du service cloud.
MailSubject	String	"${serviceType}-${metricName}-${levelDescription}Notification (${dimensions})"	L'objet de l'e-mail de notification d'alerte.
NoEffectiveInterval	String	00:00-05:30	La période pendant laquelle la règle d'alerte est inactive.
EffectiveInterval	String	05:31-23:59	La période pendant laquelle la règle d'alerte est active.
RuleName	String	Rule_01	Le nom de la règle d'alerte.
AlertState	String	OK	L'état de la règle d'alerte. Valeurs valides : OK : La règle d'alerte ne comporte aucune alerte active. ALARM : La règle d'alerte comporte des alertes actives. INSUFFICIENT_DATA : Aucune donnée n'est disponible.
Period	String	60	La période statistique.
RuleId	String	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****	L'ID de la règle d'alerte.
GroupName	String	ECS_Group	Le nom du groupe d'applications. Remarque Si la règle d'alerte est associée à un groupe d'applications, le nom du groupe d'applications est renvoyé dans ce paramètre.
GroupId	String	7301****	L'ID du groupe d'applications.
Dimensions	String	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]	Les dimensions de la règle d'alerte.
EnableState	Boolean	true	Indique si la règle d'alerte est activée. Valeurs valides : true : La règle d'alerte est activée. false : La règle d'alerte est désactivée.
Resources	String	[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]	Les ressources associées à la règle d'alerte.
Escalations	Object		Les conditions de déclenchement des différents niveaux d'alerte.
Info	Object		Les conditions de déclenchement des alertes de niveau Info.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique au seuil pour les alertes de niveau Info. Valeurs valides : GreaterThanOrEqualToThreshold : supérieur ou égal au seuil GreaterThanThreshold : supérieur au seuil LessThanOrEqualToThreshold : inférieur ou égal au seuil LessThanThreshold : inférieur au seuil NotEqualToThreshold : différent du seuil GreaterThanYesterday : supérieur à la valeur de la métrique à la même heure la veille LessThanYesterday : inférieur à la valeur de la métrique à la même heure la veille GreaterThanLastWeek : supérieur à la valeur de la métrique à la même heure la semaine précédente LessThanLastWeek : inférieur à la valeur de la métrique à la même heure la semaine précédente GreaterThanLastPeriod : supérieur à la valeur de la métrique du dernier cycle de surveillance LessThanLastPeriod : inférieur à la valeur de la métrique du dernier cycle de surveillance
PreCondition	String	$Average>80	Les conditions supplémentaires pour le déclenchement des alertes de niveau Info. Ces conditions supplémentaires prennent effet lorsque la valeur du paramètre ComparisonOperator est GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod ou LessThanLastPeriod. Par exemple, les valeurs des paramètres PreCondition, ComparisonOperator et Threshold sont respectivement définies sur $Average>80, GreaterThanYesterday et 10. Une alerte est déclenchée uniquement lorsque la valeur moyenne de la métrique est supérieure à 80 et supérieure de 10 % à la valeur moyenne de la métrique à la même heure la veille. Remarque $Average est un espace réservé composé `d'un signe dollar ($) et de la méthode statistique`. CloudMonitor remplace l'espace réservé par la valeur agrégée ou la valeur d'origine avant la comparaison des valeurs.
Times	Integer	3	Le nombre consécutif de fois où la valeur de la métrique satisfait à la condition d'alerte avant le déclenchement d'une alerte de niveau Info.
Threshold	String	90	Le seuil pour les alertes de niveau Info.
Statistics	String	Average	Les méthodes statistiques pour les alertes de niveau Info.
Warn	Object		Les conditions de déclenchement des alertes de niveau Warn.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique au seuil pour les alertes de niveau Warn. Valeurs valides : GreaterThanOrEqualToThreshold : supérieur ou égal au seuil GreaterThanThreshold : supérieur au seuil LessThanOrEqualToThreshold : inférieur ou égal au seuil LessThanThreshold : inférieur au seuil NotEqualToThreshold : différent du seuil GreaterThanYesterday : supérieur à la valeur de la métrique à la même heure la veille LessThanYesterday : inférieur à la valeur de la métrique à la même heure la veille GreaterThanLastWeek : supérieur à la valeur de la métrique à la même heure la semaine précédente LessThanLastWeek : inférieur à la valeur de la métrique à la même heure la semaine précédente GreaterThanLastPeriod : supérieur à la valeur de la métrique du dernier cycle de surveillance LessThanLastPeriod : inférieur à la valeur de la métrique du dernier cycle de surveillance
PreCondition	String	$Average>80	Les conditions supplémentaires pour le déclenchement des alertes de niveau Warn. Ces conditions supplémentaires prennent effet lorsque la valeur du paramètre ComparisonOperator est GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod ou LessThanLastPeriod. Par exemple, les valeurs des paramètres PreCondition, ComparisonOperator et Threshold sont respectivement définies sur $Average>80, GreaterThanYesterday et 10. Une alerte est déclenchée uniquement lorsque la valeur moyenne de la métrique est supérieure à 80 et supérieure de 10 % à la valeur moyenne de la métrique à la même heure la veille. Remarque $Average est un espace réservé composé `d'un signe dollar ($) et de la méthode statistique`. CloudMonitor remplace l'espace réservé par la valeur agrégée ou la valeur d'origine avant la comparaison des valeurs.
Times	Integer	3	Le nombre consécutif de fois où la valeur de la métrique satisfait à la condition d'alerte avant le déclenchement d'une alerte de niveau Warn.
Threshold	String	90	Le seuil pour les alertes de niveau Warn.
Statistics	String	Average	Les méthodes statistiques pour les alertes de niveau Warn.
Critical	Object		Les conditions de déclenchement des alertes de niveau Critical.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique au seuil pour les alertes de niveau Critical. Valeurs valides : GreaterThanOrEqualToThreshold : supérieur ou égal au seuil GreaterThanThreshold : supérieur au seuil LessThanOrEqualToThreshold : inférieur ou égal au seuil LessThanThreshold : inférieur au seuil NotEqualToThreshold : différent du seuil GreaterThanYesterday : supérieur à la valeur de la métrique à la même heure la veille LessThanYesterday : inférieur à la valeur de la métrique à la même heure la veille GreaterThanLastWeek : supérieur à la valeur de la métrique à la même heure la semaine précédente LessThanLastWeek : inférieur à la valeur de la métrique à la même heure la semaine précédente GreaterThanLastPeriod : supérieur à la valeur de la métrique du dernier cycle de surveillance LessThanLastPeriod : inférieur à la valeur de la métrique du dernier cycle de surveillance
PreCondition	String	$Average>80	Les conditions supplémentaires pour le déclenchement des alertes de niveau Critical. Ces conditions supplémentaires prennent effet lorsque la valeur du paramètre ComparisonOperator est GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod ou LessThanLastPeriod. Par exemple, les valeurs des paramètres PreCondition, ComparisonOperator et Threshold sont respectivement définies sur $Average>80, GreaterThanYesterday et 10. Une alerte est déclenchée uniquement lorsque la valeur moyenne de la métrique est supérieure à 80 et supérieure de 10 % à la valeur moyenne de la métrique à la même heure la veille. Remarque $Average est un espace réservé composé `d'un signe dollar ($) et de la méthode statistique`. CloudMonitor remplace l'espace réservé par la valeur agrégée ou la valeur d'origine avant la comparaison des valeurs.
Times	Integer	3	Le nombre consécutif de fois où la valeur de la métrique satisfait à la condition d'alerte avant le déclenchement d'une alerte de niveau Critical.
Threshold	String	90	Le seuil pour les alertes de niveau Critical.
Statistics	String	Average	Les méthodes statistiques pour les alertes de niveau Critical.
NoDataPolicy	String	KEEP_LAST_STATE	La méthode utilisée pour gérer les alertes lorsqu'aucune donnée de surveillance n'est trouvée. Valeurs valides : KEEP_LAST_STATE (par défaut) : Aucune opération n'est effectuée. INSUFFICIENT_DATA : Une alerte dont le contenu est « Insufficient data » est déclenchée. OK : L'état est considéré comme normal.
CompositeExpression	Object		Les conditions de déclenchement pour plusieurs métriques. Remarque Les conditions de déclenchement pour une seule métrique et pour plusieurs métriques s'excluent mutuellement. Vous ne pouvez pas spécifier simultanément des conditions de déclenchement pour une seule métrique et pour plusieurs métriques.
Level	String	Critical	Le niveau d'alerte. Valeurs valides : Critical Warn Info
ExpressionList	Array of ExpressionList		Les conditions de déclenchement créées en mode standard.
ExpressionList
MetricName	String	cpu_total	La métrique utilisée pour surveiller le service cloud.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique au seuil. Valeurs valides : GreaterThanOrEqualToThreshold : supérieur ou égal au seuil GreaterThanThreshold : supérieur au seuil LessThanOrEqualToThreshold : inférieur ou égal au seuil LessThanThreshold : inférieur au seuil NotEqualToThreshold : différent du seuil GreaterThanYesterday : supérieur à la valeur de la métrique à la même heure la veille LessThanYesterday : inférieur à la valeur de la métrique à la même heure la veille GreaterThanLastWeek : supérieur à la valeur de la métrique à la même heure la semaine précédente LessThanLastWeek : inférieur à la valeur de la métrique à la même heure la semaine précédente GreaterThanLastPeriod : supérieur à la valeur de la métrique du dernier cycle de surveillance LessThanLastPeriod : inférieur à la valeur de la métrique du dernier cycle de surveillance
Statistics	String	$Maximum	La méthode statistique de la métrique. Valeurs valides : $Maximum : la valeur maximale $Minimum : la valeur minimale $Average : la valeur moyenne $Availability : le taux de disponibilité (généralement utilisé pour la surveillance de site) Remarque `$` est le préfixe de la métrique. Pour plus d'informations sur les services Alibaba Cloud pris en charge par CloudMonitor, consultez Annexe 1 : Métriques.
Threshold	String	90	Le seuil d'alerte.
Period	Integer	60	La période d'agrégation de la métrique. Unité : secondes.
ExpressionListJoin	String	\|\|	La relation entre les conditions de déclenchement pour plusieurs métriques. Valeurs valides : `&&` : Une alerte est déclenchée uniquement si toutes les métriques satisfont aux conditions de déclenchement. Une alerte est déclenchée uniquement si les résultats de toutes les expressions spécifiées dans le paramètre ExpressionList sont `true`. `\|\|` : Une alerte est déclenchée si l'une des métriques satisfait aux conditions de déclenchement.
ExpressionRaw	String	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)	Les conditions de déclenchement créées à l'aide d'expressions. Vous pouvez utiliser des expressions pour créer des conditions de déclenchement dans les scénarios suivants : Définir une liste noire d'alertes pour des ressources spécifiques. Par exemple, si vous spécifiez `$instanceId != 'i-io8kfvcpp7x5**'` `&&` `$Average > 50`, aucune alerte n'est générée même lorsque la `valeur moyenne de la métrique` de l'instance `i-io8kfvcpp7x5` dépasse 50. Définir un seuil d'alerte spécial pour une instance spécifiée dans la règle. Par exemple, si vous spécifiez `$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)`, une alerte est déclenchée lorsque la `valeur moyenne de la métrique` de l'instance `i-io8kfvcpp7x5**` dépasse 80 ou lorsque la `valeur moyenne de la métrique` des autres instances dépasse 50. Limiter le nombre d'instances dont les valeurs de métrique dépassent le seuil. Par exemple, si vous spécifiez `count($Average > 20) > 3`, une alerte est déclenchée uniquement lorsque le nombre d'instances dont la `valeur moyenne de la métrique` dépasse 20 est supérieur à trois.
Times	Integer	3	Le nombre de déclenchements consécutifs. Si le nombre de fois où les valeurs de métrique satisfont aux conditions de déclenchement atteint la valeur de ce paramètre, CloudMonitor envoie des notifications d'alerte.
Labels	Array of Labels		Les tags de la règle d'alerte.
Labels
Key	String	cmsRuleKey	La clé de tag de la règle d'alerte.
Value	String	cmsRuleValue	La valeur de tag de la règle d'alerte.
Prometheus	Object		La règle d'alerte Prometheus. Remarque Ce paramètre est requis uniquement lorsque vous créez une règle d'alerte Prometheus pour Hybrid Cloud Monitoring.
PromQL	String	CpuUsage{instanceId="xxxx"}[1m]>90	L'instruction de requête PromQL. Remarque Les données obtenues à l'aide de l'instruction de requête PromQL constituent les données de surveillance. Vous devez inclure le seuil d'alerte dans cette instruction.
Level	String	Critical	Le niveau d'alerte. Valeurs valides : Critical Warn Info
Times	Long	3	Le nombre de déclenchements consécutifs. Si le nombre de fois où les valeurs de métrique satisfont aux conditions de déclenchement atteint la valeur de ce paramètre, CloudMonitor envoie des notifications d'alerte.
Annotations	Array of Annotations		Les annotations de la règle d'alerte Prometheus. Lorsqu'une alerte Prometheus est déclenchée, le système rend les clés et valeurs annotées pour vous aider à comprendre les métriques et la règle d'alerte. Remarque Ce paramètre équivaut au paramètre annotations de Prometheus open source.
Annotations
Key	String	summary	La clé de l'annotation.
Value	String	{{ $labels.instance }} CPU usage above 10 % {current value: {{ humanizePercentage $value }} }	La valeur de l'annotation.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

Format XML

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>

Format JSON

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
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.