DescribeAlertingMetricRuleResources - - Centre de documentation Alibaba Cloud

Consulte la liste des ressources qui déclenchent des alertes pour une règle d'alerte spécifiée.

Description de l'opération

Cette rubrique fournit un exemple montrant comment définir une règle d'alerte basée sur un 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 Critique est Average, l'opérateur de comparaison pour le niveau Critique est GreaterThanOrEqualToThreshold, le seuil pour le niveau Critique est 90 et le nombre de tentatives pour le niveau Critique est 3.

Remarque

Le 15 août 2024, la validation des statistiques a été renforcée. La valeur statistique doit correspondre aux statistiques de la métrique. Pour plus d'informations sur la façon d'obtenir la valeur de ce paramètre, consultez Métriques de surveillance des services Alibaba Cloud.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RuleId	string	Non	L'identifiant de la règle d'alerte. Pour plus d'informations sur la façon d'interroger les identifiants des règles d'alerte, consultez DescribeMetricRuleList.	putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****
GroupId	string	Non	L'identifiant du groupe d'applications. Pour plus d'informations sur la façon d'interroger les identifiants des groupes d'applications, consultez DescribeMonitorGroups.	7671****
Page	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 10.	10
Namespace	string	Non	L'espace de noms de données du service Alibaba Cloud. Pour plus d'informations sur la façon d'obtenir l'espace de noms de données d'un service Alibaba Cloud, consultez Métriques de surveillance des services Alibaba Cloud.	acs_mns_new
Dimensions	string	Non	Le mappage de dimensions utilisé pour interroger les données de surveillance d'une ressource spécifiée.	{\"userId\":\"120886317861****\",\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\"}
AlertBeforeTime	string	Non	Interroge les alertes qui se sont produites avant ce moment. La valeur est un horodatage en millisecondes.	1698827400000

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	Aucun.
Code	integer	Le code d'état. Remarque Une valeur de 200 indique que l'opération a réussi.	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.	0724011B-D9E0-4B2F-8C51-F17A894CC42C
Total	integer	Le nombre total d'enregistrements.	2
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
Resource	array<object>	La liste des ressources associées à la règle d'alerte.
	array<object>	Aucun.
MetricName	string	The metric name.	ActiveMessages
RetryTimes	string	The number of alert retries.	3
MetricValues	string	The metric values when the alert is triggered. The value is a JSON string.	{\"timestamp\":1623727500000,\"Sum\":926,\"value\":463,\"Maximum\":463,\"Minimum\":463,\"Average\":463,\"SampleCount\":2,\"userId\":\"120886317861****\",\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\"}
Namespace	string	The namespace of the Alibaba Cloud service.	acs_mns_new
RuleName	string	The name of the alert rule.	test123456789
RuleId	string	The ID of the alert rule.	putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****
ProductCategory	string	The type of the Alibaba Cloud service.	mns
StartTime	string	The timestamp when the resource was associated with the alert rule. Unit: milliseconds.	1622427900000
Resource	string	The resource that triggered the alert.	userId=120886317861****,region=cn-huhehaote,queue=test-0128
LastModifyTime	string	The timestamp when the alert rule was last modified. Unit: milliseconds.	1622827900000
GroupId	string	The ID of the application group. Remarque If the alert rule is associated with a specified application group, this application group ID is displayed.	7671****
Dimensions	string	The dimension map used to query monitoring data of a specified resource.	{\"region\":\"cn-huhehaote\",\"queue\":\"test-0128\",\"userId\":\"120886317861****\"}
LastAlertTime	string	The timestamp when the alert was last triggered. Unit: milliseconds.	1622427900000
Level	integer	The alert level and notification method. Valid values: 4: email + DingTalk chatbot. OK: no alert.	3
Threshold	string	The alert threshold.	10
Statistics	string	The statistical method for the alert.	Average
Enable	string	Indicates whether the alert rule is enabled. Valid values: true: The alert rule is enabled. false: The alert rule is disabled.	true
Escalation	object
Resource	array<object>	The rule that triggered the alert.
	array<object>	None.
ComparisonOperator	string	The comparison operator for the threshold. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to. GreaterThanThreshold: greater than. LessThanOrEqualToThreshold: less than or equal to. LessThanThreshold: less than. NotEqualToThreshold: not equal to. GreaterThanYesterday: greater than the value at the same time yesterday. LessThanYesterday: less than the value at the same time yesterday. GreaterThanLastWeek: greater than the value at the same time last week. LessThanLastWeek: less than the value at the same time last week. GreaterThanLastPeriod: greater than the value in the previous period. LessThanLastPeriod: less than the value in the previous period.	GreaterThanOrEqualToThreshold
PreCondition	string	The comparison operator for the threshold. Valid values: `>=` `=` `<=` `>` `<` `!=`	>=
Expression	string	The description of the rule that triggered the alert. Remarque This is the body of the alert rule. When monitoring data meets the alert condition, the alert rule is triggered.	$Average>=10
Times	integer	The number of alert retries.	1
Tag	string	This parameter is not required.	Deprecated: true
Threshold	string	The alert threshold.	10
Level	integer	The alert level and notification method. Valid values: 4: email + DingTalk chatbot. OK: no alert.	3
ExpressionListJoin	string	The relationship between multiple metrics. Valid values: &&: An alert notification is sent only when all metrics meet the alert conditions. \|\|: An alert notification is sent when any metric meets the alert conditions.	&&
ExpressionList	object
ExpressionList	array<object>	The description of the multi-metric alert rule.
	object	None.
ComparisonOperator	string	The comparison operator for the alert level threshold. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to. GreaterThanThreshold: greater than. LessThanOrEqualToThreshold: less than or equal to. LessThanThreshold: less than. NotEqualToThreshold: not equal to. GreaterThanYesterday: greater than the value at the same time yesterday. LessThanYesterday: less than the value at the same time yesterday. GreaterThanLastWeek: greater than the value at the same time last week. LessThanLastWeek: less than the value at the same time last week. GreaterThanLastPeriod: greater than the value in the previous period. LessThanLastPeriod: less than the value in the previous period.	GreaterThanOrEqualToThreshold
MetricName	string	The metric name.	cpu_total
Period	string	The statistical period of the metric. Unit: seconds. Default value: the original reporting period of the metric.	60
Statistics	string	The statistical method for the alert level. Valid values: Maximum: maximum value. Minimum: minimum value. Average: average value.	Average
Threshold	string	The alert threshold.	90
ExpressionRaw	string	The alert condition created by an expression. This includes but is not limited to the following scenarios: Set an alert blacklist for specific resources. For example, $instanceId != 'i-io8kfvcpp7x5**' ``&&`` $Average > 50 indicates that even if the `Average` of instance `i-io8kfvcpp7x5` in the alert rule exceeds 50, no alert is triggered. Set a special alert threshold for a specific instance in the rule. For example, `$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)` indicates that an alert is triggered for instance `i-io8kfvcpp7x5**` only when its `Average` exceeds 80, while other instances trigger an alert when their `Average` exceeds 50. Limit the number of instances that exceed the threshold before triggering an alert. For example, `count($Average > 20) > 3` indicates that an alert is triggered only when more than 3 instances in the alert rule have an `Average` greater than 20.	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)

Exemples

JSON format

{
  "Code": 200,
  "Message": "The request processing has failed due to some unknown error.",
  "RequestId": "0724011B-D9E0-4B2F-8C51-F17A894CC42C",
  "Total": 2,
  "Success": true,
  "Resources": {
    "Resource": [
      {
        "MetricName": "ActiveMessages",
        "RetryTimes": "3",
        "MetricValues": "{\\\"timestamp\\\":1623727500000,\\\"Sum\\\":926,\\\"value\\\":463,\\\"Maximum\\\":463,\\\"Minimum\\\":463,\\\"Average\\\":463,\\\"SampleCount\\\":2,\\\"userId\\\":\\\"120886317861****\\\",\\\"region\\\":\\\"cn-huhehaote\\\",\\\"queue\\\":\\\"test-0128\\\"}",
        "Namespace": "acs_mns_new",
        "RuleName": "test123456789",
        "RuleId": "putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****",
        "ProductCategory": "mns",
        "StartTime": "1622427900000",
        "Resource": "userId=120886317861****,region=cn-huhehaote,queue=test-0128",
        "LastModifyTime": "1622827900000",
        "GroupId": "7671****",
        "Dimensions": "{\\\"region\\\":\\\"cn-huhehaote\\\",\\\"queue\\\":\\\"test-0128\\\",\\\"userId\\\":\\\"120886317861****\\\"}",
        "LastAlertTime": "1622427900000",
        "Level": 3,
        "Threshold": "10",
        "Statistics": "Average",
        "Enable": "true",
        "Escalation": {
          "Resource": [
            {
              "ComparisonOperator": "GreaterThanOrEqualToThreshold",
              "PreCondition": ">=",
              "Expression": "$Average>=10",
              "Times": 1,
              "Tag": "Deprecated: true",
              "Threshold": "10",
              "Level": 3,
              "ExpressionListJoin": "&&",
              "ExpressionList": {
                "ExpressionList": [
                  {
                    "ComparisonOperator": "GreaterThanOrEqualToThreshold",
                    "MetricName": "cpu_total",
                    "Period": "60",
                    "Statistics": "Average",
                    "Threshold": "90"
                  }
                ]
              },
              "ExpressionRaw": "$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)"
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	%s	%s
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	%s	%s
404	%s	%s
503	%s	%s

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

Notes de version

Consultez Notes de version pour la liste complète.