PutGroupMetricRule - - Centre de documentation Alibaba Cloud

Crée ou modifie une règle d'alerte dans un groupe d'applications spécifié.

Description de l'opération

Cette rubrique fournit 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'identifiant 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 est GreaterThanOrEqualToThreshold, le seuil est 90 et le nombre de tentatives est 3. La réponse indique que la règle d'alerte est créée. L'identifiant de la règle d'alerte est 123456.

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:PutGroupMetricRule

create

*GroupMetricRule

acs:cms::{#accountId}:group/{#groupId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GroupId	string	Oui	L'identifiant du groupe d'applications. Pour plus d'informations sur la façon d'obtenir l'identifiant du groupe d'applications, consultez DescribeMonitorGroups.	17285****
RuleId	string	Oui	L'identifiant de la règle d'alerte. Pour créer une règle d'alerte pour le groupe d'applications, saisissez l'identifiant de la règle d'alerte. Pour modifier une règle d'alerte spécifiée dans le groupe d'applications, obtenez l'identifiant de la règle d'alerte. Pour plus d'informations sur la façon d'obtenir l'identifiant de la règle d'alerte, consultez DescribeMetricRuleList.	123456
Category	string	Non	L'abréviation du nom du service Alibaba Cloud. Pour plus d'informations sur la façon d'obtenir l'abréviation, consultez la balise `metricCategory` dans le paramètre de réponse `Labels` de l'opération DescribeProjectMeta.	ECS
RuleName	string	Oui	Le nom de la règle d'alerte. Pour créer une règle d'alerte pour le groupe d'applications, saisissez le nom de la règle d'alerte. Pour modifier une règle d'alerte spécifiée dans le groupe d'applications, obtenez le nom de la règle d'alerte. Pour plus d'informations sur la façon d'obtenir le nom de la règle d'alerte, consultez DescribeMetricRuleList.	Rule_01
Namespace	string	Oui	L'espace de noms du service Alibaba Cloud. Pour plus d'informations sur la façon d'obtenir l'espace de noms, consultez DescribeMetricMetaList ou Surveillance des services cloud.	acs_ecs_dashboard
MetricName	string	Oui	Le nom de la métrique. Pour plus d'informations sur la façon d'obtenir le nom de la métrique, consultez DescribeMetricMetaList ou Surveillance des services cloud.	cpu_total
Dimensions	string	Non	Les dimensions de premier niveau de la règle d'alerte dans le groupe d'applications. Format : une collection de paires `key:value`, telles que `{"userId":"120886317861**"}` et `{"instanceId":"i-m5e1qg6uo38rztr4**"}`.	[{"instanceId":"i-m5e1qg6uo38rztr4****"}]
ExtraDimensionJson	string	Non	Les dimensions de deuxième ou troisième niveau de la règle d'alerte dans le groupe d'applications. Format : une collection de paires `key:value`, telles que `port:80` et `/dev/xvda:d-m5e6yphgzn3aprwu**`. Si la dimension de premier niveau est `{"instanceId":"i-m5e1qg6uo38rztr4"}`, la dimension de deuxième niveau est le disque cloud de l'instance : `{"/dev/xvda":"d-m5e6yphgzn3aprwu**"}`.	{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}
EffectiveInterval	string	Non	La période d'efficacité pendant laquelle la règle d'alerte prend effet.	05:31-23:59
NoEffectiveInterval	string	Non	La plage horaire pendant laquelle la règle d'alerte est inactive.	00:00-05:30
SilenceTime	integer	Non	La période de silence pendant laquelle CloudMonitor n'envoie pas de notifications d'alerte répétées pour la même métrique. Unité : secondes. Valeur par défaut : 86400.	86400
Period	string	Non	La période de rapport des données de surveillance. La valeur de `Period` est 60 ou un multiple de 60. Unité : secondes. Valeur par défaut : 300.	60
Interval	string	Non	La période de détection de la règle d'alerte. Unité : secondes. Remarque Maintenez la période de détection cohérente avec la période de rapport des données. Si la période de détection est plus courte que la période de rapport des données, les alertes peuvent ne pas être déclenchées en raison de données insuffisantes.	60
Webhook	string	Non	L'URL de rappel à laquelle une requête est envoyée lorsqu'une alerte est déclenchée. Saisissez une URL accessible sur Internet. CloudMonitor envoie une requête POST pour transmettre les informations d'alerte à cette URL. Seul le protocole HTTP est pris en charge.	https://www.aliyun.com
EmailSubject	string	Non	L'objet de l'e-mail d'alerte.	Instance ECS
ContactGroups	string	Non	Le groupe de contacts d'alerte.	ECS_Group
Escalations.Critical.Statistics	string	Non	La méthode statistique pour les alertes de niveau Critical. Séparez les différentes méthodes statistiques par des virgules (,). La valeur de ce paramètre est déterminée par la colonne `Statistics` qui correspond au `MetricName` du service Alibaba Cloud spécifié, telle que Maximum, Minimum et Average. Pour plus d'informations sur la façon d'obtenir la valeur, consultez Surveillance des services cloud.	Average
Escalations.Critical.ComparisonOperator	string	Non	L'opérateur de comparaison 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 à la même heure hier. LessThanYesterday : inférieur à la valeur à la même heure hier. GreaterThanLastWeek : supérieur à la valeur à la même heure la semaine dernière. LessThanLastWeek : inférieur à la valeur à la même heure la semaine dernière. GreaterThanLastPeriod : supérieur à la valeur de la période précédente. LessThanLastPeriod : inférieur à la valeur de la période précédente.	GreaterThanOrEqualToThreshold
Escalations.Critical.Threshold	string	Non	Le seuil pour les alertes de niveau Critical.	90
Escalations.Critical.Times	integer	Non	Le nombre de tentatives pour les alertes de niveau Critical.	3
Escalations.Warn.Statistics	string	Non	La méthode statistique pour les alertes de niveau Warn. Séparez les différentes méthodes statistiques par des virgules (,). La valeur de ce paramètre est déterminée par la colonne `Statistics` qui correspond au `MetricName` du service Alibaba Cloud spécifié, telle que Maximum, Minimum et Average. Pour plus d'informations sur la façon d'obtenir la valeur, consultez Surveillance des services cloud.	Average
Escalations.Warn.ComparisonOperator	string	Non	L'opérateur de comparaison 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 à la même heure hier. LessThanYesterday : inférieur à la valeur à la même heure hier. GreaterThanLastWeek : supérieur à la valeur à la même heure la semaine dernière. LessThanLastWeek : inférieur à la valeur à la même heure la semaine dernière. GreaterThanLastPeriod : supérieur à la valeur de la période précédente. LessThanLastPeriod : inférieur à la valeur de la période précédente.	GreaterThanOrEqualToThreshold
Escalations.Warn.Threshold	string	Non	Le seuil pour les alertes de niveau Warn.	90
Escalations.Warn.Times	integer	Non	Le nombre de tentatives pour les alertes de niveau Warn.	3
Escalations.Info.Statistics	string	Non	La méthode statistique pour les alertes de niveau Info. Séparez les différentes méthodes statistiques par des virgules (,). La valeur de ce paramètre est déterminée par la colonne `Statistics` qui correspond au `MetricName` du service Alibaba Cloud spécifié, telle que Maximum, Minimum et Average. Pour plus d'informations sur la façon d'obtenir la valeur, consultez Surveillance des services cloud.	Average
Escalations.Info.ComparisonOperator	string	Non	L'opérateur de comparaison 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 à la même heure hier. LessThanYesterday : inférieur à la valeur à la même heure hier. GreaterThanLastWeek : supérieur à la valeur à la même heure la semaine dernière. LessThanLastWeek : inférieur à la valeur à la même heure la semaine dernière. GreaterThanLastPeriod : supérieur à la valeur de la période précédente. LessThanLastPeriod : inférieur à la valeur de la période précédente.	GreaterThanOrEqualToThreshold
Escalations.Info.Threshold	string	Non	Le seuil pour les alertes de niveau Info.	90
Escalations.Info.Times	integer	Non	Le nombre de tentatives pour les alertes de 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 (par défaut) : aucune action 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.	KEEP_LAST_STATE
Labels	array<object>	Non	Les balises de la règle d'alerte. Les balises sont incluses dans les notifications d'alerte.
	object	Non	Aucune.
Key	string	Non	La clé de balise de la règle d'alerte.	key1
Value	string	Non	La valeur de balise de la règle d'alerte.	value1
Options	string	Non	Les paramètres avancés. Format : {"key1":"value1","key2":"value2"}. Exemple : {"NotSendOK":true}. Ceci indique s'il faut envoyer des notifications de récupération d'alerte. La clé est NotSendOK et la valeur est true (ne pas envoyer) ou false (envoyer, qui est la valeur par défaut).	{"NotSendOK":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. Remarque Une valeur de 200 indique un succès.	200
Message	string	Le message d'erreur.	The Request is not authorization
RequestId	string	L'identifiant de la requête.	461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D
Success	boolean	Indique si l'opération a réussi. Valeurs valides : true : l'opération a réussi. false : l'opération a échoué.	true
Result	object	Le résultat de la création ou de la modification de la règle d'alerte.
RuleId	string	L'identifiant de la règle d'alerte.	123456

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	%s	%s
499	%s	%s
500	%s	%s
204	%s	%s
403	%s	%s
206	%s	%s
404	%s	%s
503	%s	%s
406	%s	%s

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

Notes de version

Consultez Notes de version pour la liste complète.

Code de statut HTTP	Code d'erreur	Message d'erreur
400	%s	%s
499	%s	%s
500	%s	%s
204	%s	%s
403	%s	%s
206	%s	%s
404	%s	%s
503	%s	%s
406	%s	%s

Code de statut HTTP	Code d'erreur	Message d'erreur
400	%s	%s
499	%s	%s
500	%s	%s
204	%s	%s
403	%s	%s
206	%s	%s
404	%s	%s
503	%s	%s
406	%s	%s

Code de statut HTTP	Code d'erreur	Message d'erreur
400	%s	%s
499	%s	%s
500	%s	%s
204	%s	%s
403	%s	%s
206	%s	%s
404	%s	%s
503	%s	%s
406	%s	%s