CreateGroupMetricRules - - Centre de documentation Alibaba Cloud

Crée des règles d'alerte par lots pour un groupe d'applications spécifié en appelant l'opération CreateGroupMetricRules.

Description de l'opération

Cette rubrique fournit un exemple de création d'une règle d'alerte pour la métrique de surveillance cpu_total du service Elastic Computing Service (ECS) dans le groupe d'applications 123456. L'identifiant de la règle d'alerte est 456789, le nom de la règle d'alerte est ECS_Rule1, la gravité de l'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 ECS_Rule1 est créée.

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

create

*GroupMetricRule

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GroupId	integer	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.	3607****
GroupMetricRules	array<object>	Non	La liste des règles d'alerte basées sur les métriques pour le groupe d'applications.
	array<object>	Non	La règle d'alerte basée sur les métriques pour le groupe d'applications.
Escalations.Info.Threshold	string	Non	Le seuil pour les alertes de niveau Info. Valeurs valides de N : 1 à 200. Remarque Définissez au moins l'un des niveaux de gravité d'alerte Critical, Warn ou Info. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	10
MetricName	string	Oui	Le nom de la métrique. Valeurs valides de N : 1 à 200. 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
Escalations.Warn.Threshold	string	Non	Le seuil pour les alertes de niveau Warn. Valeurs valides de N : 1 à 200. Remarque Définissez au moins l'un des niveaux de gravité d'alerte Critical, Warn ou Info. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	20
EffectiveInterval	string	Non	La période d'efficacité de la règle d'alerte. Valeurs valides de N : 1 à 200.	05:31-23:59
NoEffectiveInterval	string	Non	La période pendant laquelle la règle d'alerte est inactive. Valeurs valides de N : 1 à 200.	00:00-05:30
RuleId	string	Oui	L'identifiant de la règle d'alerte. Valeurs valides de N : 1 à 200.	456789
Escalations.Critical.Times	integer	Non	Le nombre de fois où la métrique de surveillance doit atteindre le seuil d'alerte avant qu'une notification d'alerte de niveau Critical ne soit envoyée. Valeurs valides de N : 1 à 200. Remarque Les paramètres d'au moins l'un des niveaux de gravité d'alerte Critical, Warn (avertissement) ou Info doivent être spécifiés. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	3
Dimensions	string	Non	Les dimensions de surveillance de la ressource spécifiée. La valeur est une collection de paires `clé:valeur`, telles que `{"userId":"120886317861**"}` et `{"instanceId":"i-2ze2d6j5uhg20x47**"}`.	[{"instanceId":"i-m5e1qg6uo38rztr4****"}]
Escalations.Critical.Threshold	string	Non	Le seuil qui déclenche les notifications d'alerte de niveau Critical. Valeurs valides de N : 1 à 200. Remarque Définissez au moins l'un des niveaux de gravité d'alerte Critical, Warn ou Info. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	90
Escalations.Critical.Statistics	string	Non	La méthode statistique pour les alertes de niveau Critical. Valeurs valides de N : 1 à 200. Les valeurs valides de ce paramètre sont déterminées par la colonne `Statistics` correspondant au `MetricName` du service Alibaba Cloud spécifié, telles que Maximum, Minimum et Average. Pour plus d'informations sur la façon d'obtenir les valeurs valides, consultez Surveillance des services cloud. Remarque Définissez au moins l'un des niveaux de gravité d'alerte Critical, Warn ou Info. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	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. Valeurs valides de N : 1 à 200. Remarque Définissez au moins l'un des niveaux de gravité d'alerte Critical, Warn ou Info. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	GreaterThanOrEqualToThreshold
Escalations.Info.Times	integer	Non	Le nombre de fois où la métrique de surveillance doit atteindre le seuil d'alerte avant qu'une notification d'alerte de niveau Info ne soit envoyée. Valeurs valides de N : 1 à 200. Remarque Les paramètres d'au moins l'un des niveaux de gravité d'alerte Critical, Warn (avertissement) ou Info doivent être spécifiés. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	1
SilenceTime	integer	Non	La période de mise en sourdine de la notification d'alerte. Valeurs valides de N : 1 à 200. Unité : secondes. Valeur par défaut : 86400. Valeur minimale : 3600.	86400
Webhook	string	Non	L'URL de rappel à laquelle une notification d'alerte est envoyée. Valeurs valides de N : 1 à 200. Spécifiez une URL accessible publiquement. 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
Namespace	string	Oui	L'espace de noms du service Alibaba Cloud. Valeurs valides de N : 1 à 200. Pour plus d'informations sur la façon d'obtenir l'espace de noms d'un service Alibaba Cloud, consultez DescribeMetricMetaList ou Surveillance des services cloud.	acs_ecs_dashboard
EmailSubject	string	Non	L'objet de l'e-mail de notification d'alerte. Valeurs valides de N : 1 à 200.	Instance ECS
Period	string	Non	La période de rapport des données de surveillance. Valeurs valides de N : 1 à 200. La valeur de `Period` doit être 60 ou un multiple de 60. Unité : secondes. Valeur par défaut : 300.	60
RuleName	string	Oui	Le nom de la règle d'alerte. Valeurs valides de N : 1 à 200.	ECS_Rule1
Escalations.Info.Statistics	string	Non	La méthode statistique pour les alertes de niveau Info. Valeurs valides de N : 1 à 200. Les valeurs valides de ce paramètre sont déterminées par la colonne `Statistics` correspondant au `MetricName` du service Alibaba Cloud spécifié, telles que Maximum, Minimum et Average. Pour plus d'informations sur la façon d'obtenir les valeurs valides, consultez Surveillance des services cloud. Remarque Définissez au moins l'un des niveaux de gravité d'alerte Critical, Warn ou Info. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	Average
Escalations.Warn.Times	integer	Non	Le nombre de fois où la métrique de surveillance doit atteindre le seuil d'alerte avant qu'une notification d'alerte de niveau Warn ne soit envoyée. Valeurs valides de N : 1 à 200. Remarque Les paramètres d'au moins l'un des niveaux de gravité d'alerte Critical, Warn (avertissement) ou Info doivent être spécifiés. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	3
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. Valeurs valides de N : 1 à 200. Remarque Définissez au moins l'un des niveaux de gravité d'alerte Critical, Warn ou Info. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	GreaterThanOrEqualToThreshold
Interval	string	Non	La période de détection de la règle d'alerte. Valeurs valides de N : 1 à 200. Unité : secondes. La valeur par défaut est la fréquence de rapport minimale de la métrique. Remarque Maintenez la période de détection de la règle d'alerte 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
Category	string	Oui	L'abréviation du nom du service Alibaba Cloud. Valeurs valides de N : 1 à 200. 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
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. Valeurs valides de N : 1 à 200. Remarque Définissez au moins l'un des niveaux de gravité d'alerte Critical, Warn ou Info. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	GreaterThanOrEqualToThreshold
Escalations.Warn.Statistics	string	Non	La méthode statistique pour les alertes de niveau Warn. Valeurs valides de N : 1 à 200. Les valeurs valides de ce paramètre sont déterminées par la colonne `Statistics` correspondant au `MetricName` du service Alibaba Cloud spécifié, telles que Maximum, Minimum et Average. Pour plus d'informations sur la façon d'obtenir les valeurs valides, consultez Surveillance des services cloud. Remarque Définissez au moins l'un des niveaux de gravité d'alerte Critical, Warn ou Info. Pour chaque niveau de gravité d'alerte spécifié, vous devez définir tous les paramètres suivants : Statistics, ComparisonOperator, Threshold et Times.	Average
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. Valeurs valides de N : 1 à 200.	KEEP_LAST_STATE
ContactGroups	string	Non	Le groupe de contacts d'alerte. Valeurs valides de N : 1 à 200. Pour plus d'informations sur la façon d'obtenir le groupe de contacts d'alerte, consultez DescribeContactGroupList.	ECS_Group
Labels	array<object>	Non	Les clés de balise de la règle d'alerte.
	object	Non	Les clés de balise de la règle d'alerte.
Key	string	Non	La clé de balise de la règle d'alerte. La balise est incluse dans les notifications d'alerte. Valeurs valides de N : 1 à 200.	key1
Value	string	Non	La valeur de balise de la règle d'alerte. La balise est incluse dans les notifications d'alerte. Valeurs valides de N : 1 à 200.	value1
Options	string	Non	Les paramètres avancés. Format : {"key1":"value1","key2":"value2"}. Par exemple, {"NotSendOK":true} indique s'il faut envoyer une notification de récupération d'alerte. La clé est NotSendOK et la valeur est true (ne pas envoyer) ou false (envoyer, ce 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
Code	integer	Le code d'état. Remarque Une valeur de 200 indique un succès.	200
Message	string	Le message d'erreur.	La requête n'est pas autorisée
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
Resources	object
AlertResult	array<object>	La liste des règles d'alerte.
	object
Code	integer	The status code of the newly created alert rule. Remarque A value of 200 indicates success.	200
Message	string	The error message of the newly created alert rule.	Metric not found.
Success	boolean	Indicates whether the alert rule is created. Valid values: true: The alert rule is created. false: The alert rule failed to be created.	true
RuleName	string	The name of the newly created alert rule.	ECS_Rule1
RuleId	string	The ID of the newly created alert rule.	456789

Exemples

JSON format

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
  "Success": true,
  "Resources": {
    "AlertResult": [
      {
        "Code": 200,
        "Message": "Metric not found.",
        "Success": true,
        "RuleName": "ECS_Rule1",
        "RuleId": "456789"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	%s	%s
412	%s	%s
500	%s	%s
500	500	%s
403	%s	%s
404	%s	%s
409	%s	%s

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

Notes de version

Consultez Notes de version pour la liste complète.