PutGroupMetricRule - - Centre de documentation Alibaba Cloud

Cette rubrique présente un exemple de création d'une règle d'alerte pour la métrique cpu_total d'Elastic Compute Service (ECS) dans le groupe d'applications 17285****. L'ID de la règle d'alerte est 123456. Le nom de la règle d'alerte est Rule_test. Le niveau d'alerte est Critical. La méthode statistique est Average. L'opérateur de comparaison du seuil d'alerte est GreaterThanOrEqualToThreshold. Le seuil d'alerte est 90. Le nombre de tentatives d'alerte est 3. Le résultat renvoyé indique que la règle d'alerte a été créée et que son ID est 123456.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de la 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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	PutGroupMetricRule	L'opération que vous souhaitez effectuer. Définissez la valeur sur PutGroupMetricRule.
GroupId	String	Oui	17285****	L'ID du groupe d'applications. Pour savoir comment obtenir l'ID d'un groupe d'applications, consultez DescribeMonitorGroups.
RuleId	String	Oui	123456	L'ID de la règle d'alerte. Lorsque vous créez une règle d'alerte pour le groupe d'applications, saisissez l'ID de la règle d'alerte. Lorsque vous modifiez une règle d'alerte spécifique dans le groupe d'applications, vous devez obtenir l'ID de la règle d'alerte. Pour savoir comment obtenir l'ID d'une règle d'alerte, consultez DescribeMetricRuleList.
Category	String	Non	ECS	L'abréviation du nom du service cloud. Pour plus d'informations sur l'obtention de l'abréviation d'un nom de service cloud, consultez `metricCategory` dans le paramètre de réponse `Labels` de l'opération DescribeProjectMeta.
RuleName	String	Oui	Rule_01	Le nom de la règle d'alerte. Lorsque vous créez une règle d'alerte pour le groupe d'applications, saisissez le nom de la règle d'alerte. Lorsque vous modifiez une règle d'alerte spécifique dans le groupe d'applications, vous devez obtenir le nom de la règle d'alerte. Pour savoir comment obtenir le nom d'une règle d'alerte, consultez DescribeMetricRuleList.
Namespace	String	Oui	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.
MetricName	String	Oui	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.
Dimensions	String	Non	[{"instanceId":"i-m5e1qg6uo38rztr4****"}]	La dimension de premier niveau de la règle d'alerte dans le groupe d'applications. Définissez la valeur sur une collection de paires `key:value`. Exemple : `{"userId":"120886317861"}` ou `{"instanceId":"i-m5e1qg6uo38rztr4"}`.
ExtraDimensionJson	String	Non	{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}	La dimension de deuxième ou troisième niveau de la règle d'alerte dans le groupe d'applications. Définissez la valeur sur une collection de paires `key:value`. Exemple : `port:80` ou `/dev/xvda:d-m5e6yphgzn3aprwu**`. Si la dimension de premier niveau de la règle d'alerte est `{"instanceId":"i-m5e1qg6uo38rztr4"}`, sa dimension de deuxième niveau correspond au disque `{"/dev/xvda":"d-m5e6yphgzn3aprwu**"}` de l'instance.
EffectiveInterval	String	Non	05:31-23:59	La période pendant laquelle la règle d'alerte est effective.
NoEffectiveInterval	String	Non	00:00-05:30	La période pendant laquelle la règle d'alerte n'est pas effective.
SilenceTime	Integer	Non	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.
Period	String	Non	60	La période d'agrégation des données de métrique. Définissez le paramètre `Period` sur un multiple entier de 60. Unité : secondes. Valeur par défaut : 300.
Interval	String	Non	60	L'intervalle auquel CloudMonitor vérifie si la règle d'alerte est déclenchée. Unité : secondes. Remarque Nous vous recommandons de définir l'intervalle sur la période d'agrégation des données. Si l'intervalle est inférieur à la période d'agrégation des données, les alertes ne peuvent pas être déclenchées en raison d'un manque de données.
Webhook	String	Non	https://www.aliyun.com	L'URL de rappel. L'URL de rappel doit être accessible via Internet. CloudMonitor envoie une requête POST pour pousser une notification d'alerte vers l'URL de rappel que vous spécifiez. Seules les requêtes HTTP sont prises en charge.
EmailSubject	String	Non	ECS instance	L'objet de l'e-mail de notification d'alerte.
ContactGroups	String	Non	ECS_Group	Les groupes de contacts d'alerte.
Escalations.Critical.Statistics	String	Non	Average	Les méthodes statistiques pour les alertes de niveau Critical. Séparez plusieurs méthodes statistiques par des virgules (,). La valeur de ce paramètre est déterminée par la colonne `Statistics` correspondant au paramètre `MetricName` du service cloud spécifié. La valeur de ce paramètre peut être Maximum, Minimum ou Average. Pour plus d'informations sur l'obtention de la valeur de ce paramètre, consultez Annexe 1 : Métriques.
Escalations.Critical.ComparisonOperator	String	Non	GreaterThanOrEqualToThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique avec le 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 lors du dernier cycle de surveillance LessThanLastPeriod : inférieur à la valeur de la métrique lors du dernier cycle de surveillance
Escalations.Critical.Threshold	String	Non	90	Le seuil pour les alertes de niveau Critical.
Escalations.Critical.Times	Integer	Non	3	Le nombre consécutif de fois où la valeur de la métrique respecte la condition d'alerte avant qu'une alerte de niveau Critical ne soit déclenchée.
Escalations.Warn.Statistics	String	Non	Average	Les méthodes statistiques pour les alertes de niveau Warn. Séparez plusieurs méthodes statistiques par des virgules (,). La valeur de ce paramètre est déterminée par la colonne `Statistics` correspondant au paramètre `MetricName` du service cloud spécifié. La valeur de ce paramètre peut être Maximum, Minimum ou Average. Pour plus d'informations sur l'obtention de la valeur de ce paramètre, consultez Annexe 1 : Métriques.
Escalations.Warn.ComparisonOperator	String	Non	GreaterThanOrEqualToThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique avec le 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 lors du dernier cycle de surveillance LessThanLastPeriod : inférieur à la valeur de la métrique lors du dernier cycle de surveillance
Escalations.Warn.Threshold	String	Non	90	Le seuil pour les alertes de niveau Warn.
Escalations.Warn.Times	Integer	Non	3	Le nombre consécutif de fois où la valeur de la métrique respecte la condition d'alerte avant qu'une alerte de niveau Warn ne soit déclenchée.
Escalations.Info.Statistics	String	Non	Average	Les méthodes statistiques pour les alertes de niveau Info. Séparez plusieurs méthodes statistiques par des virgules (,). La valeur de ce paramètre est déterminée par la colonne `Statistics` correspondant au paramètre `MetricName` du service cloud spécifié. La valeur de ce paramètre peut être Maximum, Minimum ou Average. Pour plus d'informations sur l'obtention de la valeur de ce paramètre, consultez Annexe 1 : Métriques.
Escalations.Info.ComparisonOperator	String	Non	GreaterThanOrEqualToThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique avec le 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 lors du dernier cycle de surveillance LessThanLastPeriod : inférieur à la valeur de la métrique lors du dernier cycle de surveillance
Escalations.Info.Threshold	String	Non	90	Le seuil pour les alertes de niveau Info.
Escalations.Info.Times	Integer	Non	3	Le nombre consécutif de fois où la valeur de la métrique respecte la condition d'alerte avant qu'une alerte de niveau Info ne soit déclenchée.
NoDataPolicy	String	Non	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 : Le statut est considéré comme normal.
Labels.N.Key	String	Non	key1	La clé du tag de la règle d'alerte.
Labels.N.Value	String	Non	value1	La valeur du tag de la règle d'alerte.

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

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	200	Le code d'état HTTP. Remarque Le code d'état 200 indique que la requête a réussi.
Message	String	The Request is not authorization.	Le message d'erreur.
RequestId	String	461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D	L'ID de la requête.
Success	Boolean	true	Indique si la requête a réussi. Valeurs valides : true false
Result	Object		Le résultat de la requête.
RuleId	String	123456	L'ID de la règle d'alerte.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=PutGroupMetricRule
&Category=ECS
&GroupId=17285****
&MetricName=cpu_total
&Namespace=acs_ecs_dashboard
&RuleId=123456
&RuleName=`Rule_test
&Escalations.Critical.Statistics=Average
&Escalations.Critical.ComparisonOperator=GreaterThanOrEqualToThreshold
&Escalations.Critical.Threshold=90
&Escalations.Critical.Times=3
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<PutGroupMetricRuleResponse>
	<Message></Message>
	<RequestId>461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D</RequestId>
	<Code>200</Code>
	<Success>true</Success>
	<Result>
		<RuleId>123456</RuleId>
	</Result>
</PutGroupMetricRuleResponse>

Format JSON

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

{
  "Message" : "",
  "RequestId" : "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
  "Code" : 200,
  "Success" : true,
  "Result" : {
    "RuleId" : "123456"
  }
}

Codes d'erreur

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