PutResourceMetricRule - - Centre de documentation Alibaba Cloud

Définit une règle d'alerte.

Description de l'opération

Cette rubrique fournit un exemple de définition d'une règle d'alerte de seuil pour la métrique cpu_total de l'instance Elastic Compute Service (ECS) i-uf6j91r34rnwawoo**** dans l'espace de noms acs_ecs_dashboard. Le groupe de contacts d'alerte est ECS_Group, le nom de la règle d'alerte est test123, l'identifiant de la règle d'alerte est a151cd6023eacee2f0978e03863cc1697c89508****, la méthode statistique pour le niveau Critical est Average, l'opérateur de comparaison pour le niveau Critical est GreaterThanOrEqualToThreshold, le seuil pour le niveau Critical est 90 et le nombre de tentatives pour le niveau Critical est 3.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

cms:PutResourceMetricRule

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RuleId	string	Oui	L'identifiant de la règle d'alerte.	a151cd6023eacee2f0978e03863cc1697c89508****
RuleName	string	Oui	Le nom de la règle d'alerte.	test123
Namespace	string	Oui	L'espace de noms du service Alibaba Cloud. Pour plus d'informations sur la façon d'interroger l'espace de noms d'un service Alibaba Cloud, consultez Métriques de surveillance des services Alibaba Cloud.	acs_ecs_dashboard
MetricName	string	Oui	Le nom de la métrique. Pour plus d'informations sur la façon d'interroger les noms des métriques, consultez Métriques de surveillance des services Alibaba Cloud.	cpu_total
Resources	string	Non	Les informations sur la ressource, telles que `[{"instanceId":"i-uf6j91r34rnwawoo**"}]` ou `[{"userId":"100931896542**"}]`.	[{"instanceId":"i-uf6j91r34rnwawoo****"}]
ContactGroups	string	Oui	Le groupe de contacts d'alerte. Les notifications d'alerte sont envoyées aux contacts d'alerte du groupe de contacts d'alerte.	ECS_Group
Webhook	string	Non	L'URL de rappel à laquelle une requête POST est envoyée lorsqu'une alerte est déclenchée.	https://alert.aliyun.com.com:8080/callback
EffectiveInterval	string	Non	La période d'efficacité de la règle d'alerte.	00:00-23:59
NoEffectiveInterval	string	Non	La plage horaire pendant laquelle la règle d'alerte est inactive.	00:00-06:00
SilenceTime	integer	Non	La période de mise en sourdine. Unité : secondes. Valeur par défaut : 86400.	86400
Period	string	Non	La période statistique de la métrique. Unité : secondes. La valeur par défaut est la période de rapport d'origine de la métrique.	60
Interval	string	Non	La période de déclenchement de la règle d'alerte. Unité : secondes.	60
EmailSubject	string	Non	L'objet de l'e-mail d'alerte.	Alerte d'instance ECS
Escalations.Critical.Statistics	string	Non	La méthode statistique pour le niveau Critical.	Average
Escalations.Critical.ComparisonOperator	string	Non	L'opérateur de comparaison pour le niveau Critical. Valeurs valides :	GreaterThanOrEqualToThreshold
Escalations.Critical.Threshold	string	Non	Le seuil pour le niveau Critical.	90
Escalations.Critical.Times	integer	Non	Le nombre de tentatives pour le niveau Critical.	3
Escalations.Warn.Statistics	string	Non	La méthode statistique pour le niveau Warn.	Average
Escalations.Warn.ComparisonOperator	string	Non	L'opérateur de comparaison pour le niveau Warn. Valeurs valides :	GreaterThanOrEqualToThreshold
Escalations.Warn.Threshold	string	Non	Le seuil pour le niveau Warn.	90
Escalations.Warn.Times	integer	Non	Le nombre de tentatives pour le niveau Warn.	3
Escalations.Info.Statistics	string	Non	La méthode statistique pour le niveau Info.	Average
Escalations.Info.ComparisonOperator	string	Non	L'opérateur de comparaison pour le niveau Info. Valeurs valides :	GreaterThanOrEqualToThreshold
Escalations.Info.Threshold	string	Non	Le seuil pour le niveau Info.	90
Escalations.Info.Times	integer	Non	Le nombre de tentatives pour le niveau Info.	3
NoDataPolicy	string	Non	La méthode de traitement lorsqu'aucune donnée de surveillance n'est trouvée. Valeurs valides :	KEEP_LAST_STATE
CompositeExpression	object	Non	Les conditions d'alerte pour plusieurs métriques.
ExpressionList	array<object>	Non	La liste des conditions d'alerte créées en mode standard.
	object	Non	Aucune.
MetricName	string	Non	Le nom de la métrique du service Alibaba Cloud.	cpu_total
Period	integer	Non	La période d'agrégation de la métrique.	60
Statistics	string	Non	La méthode statistique de la métrique. Valeurs valides :	$Maximum
ComparisonOperator	string	Non	L'opérateur de comparaison pour le seuil. Valeurs valides :	GreaterThanOrEqualToThreshold
Threshold	string	Non	Le seuil d'alerte.	90
ExpressionListJoin	string	Non	La relation entre les conditions d'alerte pour plusieurs métriques. Valeurs valides :	\|\|
ExpressionRaw	string	Non	La condition d'alerte créée à l'aide d'une expression. Cela inclut, sans s'y limiter, les scénarios suivants :	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)
Level	string	Non	Le niveau d'alerte. Valeurs valides :	CRITICAL
Times	integer	Non	Le nombre de fois que la condition d'alerte doit être remplie avant qu'une notification d'alerte ne soit envoyée.	3
Labels	array<object>	Non	Lorsque la métrique remplit la condition d'alerte et qu'une alerte est déclenchée, les étiquettes sont écrites dans la métrique et affichées dans la notification d'alerte.
	object	Non	Aucune.
Key	string	Non	La clé de l'étiquette.	tagKey1
Value	string	Non	La valeur de l'étiquette.	ECS
Prometheus	object	Non	La configuration d'alerte Prometheus.
PromQL	string	Non	L'instruction de requête PromQL.	cpuUsage{instanceId="xxxx"}[1m]>90
Level	string	Non	Le niveau d'alerte. Valeurs valides :	CRITICAL
Times	integer	Non	Le nombre de fois que la condition d'alerte doit être remplie avant qu'une notification d'alerte ne soit envoyée.	3
Annotations	array<object>	Non	Les annotations pour les alertes Prometheus. Les clés et valeurs d'annotation sont rendues pour vous aider à comprendre les métriques ou les règles d'alerte.
	object	Non	Aucune.
Key	string	Non	La clé d'annotation.	summary
Value	string	Non	La valeur d'annotation.	{{ $labels.instance }} Utilisation du processeur supérieure à 10 % {valeur actuelle : {{ humanizePercentage $value }} }
SendOK	boolean	Non	Indique si une notification de rétablissement doit être envoyée.	true

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

Éléments de réponse

Élément	Type	Description	Exemple
	object	Aucune.
Code	string	Le code d'état HTTP.	200
Message	string	Le message d'erreur.	Le traitement de la requête a échoué en raison d'une erreur inconnue
RequestId	string	L'identifiant de la requête.	65D50468-ECEF-48F1-A6E1-D952E89D9436
Success	boolean	Indique si l'opération a réussi. Valeurs valides :	true

Exemples

JSON format

{
  "Code": "200",
  "Message": "The request processing has failed due to some unknown error.",
  "RequestId": "65D50468-ECEF-48F1-A6E1-D952E89D9436",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	%s	%s
499	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
204	%s	%s
403	%s	%s
206	%s	%s
404	%s	%s
503	%s	%s
406	%s	%s
429	ResourceOverLimit	The resource has exceeded the limit. %s

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.