DescribeActiveMetricRuleList - - Centre de documentation Alibaba Cloud

Interroge les détails des règles d'alerte proactive.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer pour plus de commodité. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre

Type

Obligatoire

Exemple

Description

Action

String

Oui

DescribeActiveMetricRuleList

L'opération à effectuer. Définissez la valeur sur DescribeActiveMetricRuleList.

Product

String

Oui

ecs

L'abréviation du service cloud qui prend en charge les règles d'alerte proactive.

Pour savoir comment obtenir le nom d'un service cloud, consultez DescribeProductsOfActiveMetricRule.

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 abouti.
Message	String	The Request is not authorization.	Le message d'erreur.
RequestId	String	F82E6667-7811-4BA0-842F-5B2DC42BBAAD	L'ID de requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true false
Datapoints	Array of Alarm		Les détails des règles d'alerte.
Alarm
SilenceTime	String	86400	La période de silence pendant laquelle aucune nouvelle alerte n'est envoyée, même si les conditions de déclenchement sont remplies. Unité : secondes.
MetricName	String	cpu_total	Le nom de la métrique.
EvaluationCount	String	3	Le nombre consécutif de fois où la valeur de la métrique satisfait à la condition de déclenchement avant qu'une alerte ne soit générée.
Webhook	String	https://www.aliyun.com	L'URL de rappel.
State	String	Enable	Indique si la règle d'alerte est activée.
ContactGroups	String	ECS_Group	Le groupe de contacts d'alerte.
Namespace	String	acs_ecs_dashboard	Le namespace du service cloud.
RuleName	String	SystemDefault_acs_rds_dashboard_CpuUsage	Le nom de la règle d'alerte.
RuleId	String	a151cd6023eacee2f0978e03863cc1697c89508****	L'ID de la règle d'alerte.
Period	String	60	La période d'agrégation des données de surveillance. Unité : secondes.
ComparisonOperator	String	>	L'opérateur de comparaison utilisé dans la règle d'alerte. Valeurs possibles : `>` `<` `>=` `<=` `=` `=`
EndTime	String	24	La fin de la période pendant laquelle la règle d'alerte est effective. Unité : heures. Par exemple, la valeur 23 indique `23:59:59`.
StartTime	String	00	Le début de la période pendant laquelle la règle d'alerte est effective. Unité : heures. Par exemple, la valeur 00 indique `00:00:00`.
Threshold	String	90	Le seuil d'alerte.
Statistics	String	Average	La méthode statistique.
Enable	String	true	Indique si la règle d'alerte est activée. Valeurs possibles : true : la règle d'alerte est activée. false : la règle d'alerte est désactivée.
AlertList	Array of Alert		Les détails des règles d'alerte. Le résultat présente la même structure que celui renvoyé par l'opération DescribeMetricRuleList.
Alert
SilenceTime	String	86400	La période de silence pendant laquelle aucune nouvelle alerte n'est envoyée, même si les conditions de déclenchement sont remplies. Unité : secondes.
MetricName	String	cpu_total	Le nom de la métrique.
Webhook	String	http://www.aliyun.com	L'URL de rappel.
ContactGroups	String	ECS_Group	Le groupe de contacts d'alerte.
Namespace	String	acs_ecs_dashboard	Le namespace du service cloud.
EffectiveInterval	String	00:00-23:59	La période pendant laquelle la règle d'alerte est effective.
NoEffectiveInterval	String	00:00-06:00	La période pendant laquelle la règle d'alerte n'est pas effective.
MailSubject	String	ECS_Bucket	L'objet de l'e-mail de notification d'alerte.
RuleName	String	myAlert	Le nom de la règle d'alerte.
RuleId	String	ruleIdxxxx	L'ID de la règle d'alerte.
Period	String	60	La période d'agrégation des données de surveillance. Unité : secondes.
AlertState	String	OK	L'état de la règle d'alerte. Valeurs possibles : OK : la règle d'alerte ne comporte aucune alerte active. ALARM : la règle d'alerte comporte des alertes actives. INSUFFICIENT_DATA : aucune donnée n'est disponible.
Dimensions	String	""	Les données de surveillance de la ressource spécifiée.
EnableState	Boolean	true	Indique si la règle d'alerte est activée. Valeurs possibles : true : la règle d'alerte est activée. false : la règle d'alerte est désactivée.
Resources	String	[{"resource":"_ALL"}]	Les ressources associées à la règle d'alerte.
Escalations	Object		Les conditions de déclenchement des différents niveaux d'alerte.
Info	Object		Les conditions de déclenchement des alertes de niveau Info.
ComparisonOperator	String	GreaterThanThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique au seuil pour les alertes de niveau Info. Valeurs possibles : 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 hier LessThanYesterday : inférieur à la valeur de la métrique à la même heure hier GreaterThanLastWeek : supérieur à la valeur de la métrique à la même heure la semaine dernière LessThanLastWeek : inférieur à la valeur de la métrique à la même heure la semaine dernière 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
Times	String	3	Le nombre consécutif de fois où la valeur de la métrique dépasse le seuil pour les alertes de niveau Info avant qu'une alerte ne soit générée.
Threshold	String	95	Le seuil pour les alertes de niveau Info.
Statistics	String	Average	Les méthodes statistiques pour les alertes de niveau Info.
Warn	Object		La condition de déclenchement des alertes de niveau Warn.
ComparisonOperator	String	GreaterThanThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique au seuil pour les alertes de niveau Critical. Valeurs possibles : 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 hier LessThanYesterday : inférieur à la valeur de la métrique à la même heure hier GreaterThanLastWeek : supérieur à la valeur de la métrique à la même heure la semaine dernière LessThanLastWeek : inférieur à la valeur de la métrique à la même heure la semaine dernière 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
Times	String	3	Le nombre consécutif de fois où la valeur de la métrique dépasse le seuil pour les alertes de niveau Warn avant qu'une alerte ne soit générée.
Threshold	String	80	Le seuil pour les alertes de niveau Warn.
Statistics	String	Average	Les méthodes statistiques pour les alertes de niveau Warn.
Critical	Object		Les conditions de déclenchement des alertes de niveau Critical.
ComparisonOperator	String	GreaterThanThreshold	L'opérateur de comparaison utilisé pour comparer la valeur de la métrique au seuil pour les alertes de niveau Critical. Valeurs possibles : 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 hier LessThanYesterday : inférieur à la valeur de la métrique à la même heure hier GreaterThanLastWeek : supérieur à la valeur de la métrique à la même heure la semaine dernière LessThanLastWeek : inférieur à la valeur de la métrique à la même heure la semaine dernière 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
Times	String	3	Le nombre consécutif de fois où la valeur de la métrique dépasse le seuil pour les alertes de niveau Critical avant qu'une alerte ne soit générée.
Threshold	String	99	Le seuil pour les alertes de niveau Critical.
Statistics	String	Average	Les méthodes statistiques pour les alertes de niveau Critical.

Exemples

Exemple de requêtes

http(s)://[Endpoint]/?Action=DescribeActiveMetricRuleList
&Product=ecs
&<Common request parameters>

Exemple de réponses réussies

Format XML

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

<DescribeActiveMetricRuleListResponse>
        <AlertList>
            <Alert>
                <SilenceTime>86400</SilenceTime>
                <ContactGroups>ECS_Group</ContactGroups>
                <NoEffectiveInterval></NoEffectiveInterval>
                <MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>
                <RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>
                <Period>300</Period>
                <Dimensions></Dimensions>
                <EffectiveInterval></EffectiveInterval>
                <Namespace>acs_rds_dashboard</Namespace>
                <AlertState>INSUFFICIENT_DATA</AlertState>
                <MetricName>IOPSUsage</MetricName>
                <EnableState>true</EnableState>
                <Escalations>
                    <Critical />
                    <Info>
                        <ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
                        <Times>5</Times>
                        <Statistics>Average</Statistics>
                        <Threshold>80</Threshold>
                    </Info>
                    <Warn />
                </Escalations>
                <Webhook></Webhook>
                <Resources>[{\"resource\":\"_ALL\"}]</Resources>
                <RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>
            </Alert>
            <Alert>
                <SilenceTime>86400</SilenceTime>
                <ContactGroups>ECS_Group</ContactGroups>
                <NoEffectiveInterval></NoEffectiveInterval>
                <MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>
                <RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>
                <Period>300</Period>
                <Dimensions></Dimensions>
                <EffectiveInterval></EffectiveInterval>
                <Namespace>acs_rds_dashboard</Namespace>
                <AlertState>INSUFFICIENT_DATA</AlertState>
                <MetricName>CpuUsage</MetricName>
                <EnableState>true</EnableState>
                <Escalations>
                    <Critical />
                    <Info>
                        <ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
                        <Times>5</Times>
                        <Statistics>Average</Statistics>
                        <Threshold>80</Threshold>
                    </Info>
                    <Warn />
                </Escalations>
                <Webhook></Webhook>
                <Resources>[{\"resource\":\"_ALL\"}]</Resources>
                <RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>
            </Alert>
        </AlertList>
        <Datapoints>
            <Alarm>
                <SilenceTime>86400</SilenceTime>
                <ContactGroups>[\"Alice\"]</ContactGroups>
                <ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
                <EndTime></EndTime>
                <RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>
                <StartTime></StartTime>
                <Period>300</Period>
                <EvaluationCount>5</EvaluationCount>
                <Statistics>Average</Statistics>
                <Namespace>acs_rds_dashboard</Namespace>
                <MetricName>IOPSUsage</MetricName>
                <State>INSUFFICIENT_DATA</State>
                <Enable>true</Enable>
                <Webhook></Webhook>
                <RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>
                <Threshold>80</Threshold>
            </Alarm>
            <Alarm>
                <SilenceTime>86400</SilenceTime>
                <ContactGroups>[\"Jim\"]</ContactGroups>
                <ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
                <EndTime></EndTime>
                <RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>
                <StartTime></StartTime>
                <Period>300</Period>
                <EvaluationCount>5</EvaluationCount>
                <Statistics>Average</Statistics>
                <Namespace>acs_rds_dashboard</Namespace>
                <MetricName>CpuUsage</MetricName>
                <State>INSUFFICIENT_DATA</State>
                <Enable>true</Enable>
                <Webhook></Webhook>
                <RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>
                <Threshold>80</Threshold>
            </Alarm>
        </Datapoints>
        <Code>200</Code>
        <Success>true</Success>
</DescribeActiveMetricRuleListResponse>

Format JSON

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

{
  "AlertList" : {
    "Alert" : [ {
      "SilenceTime" : 86400,
      "ContactGroups" : "ECS_Group",
      "NoEffectiveInterval" : "",
      "MailSubject" : "${serviceType}-${metricName}-${levelDescription}",
      "RuleId" : "SystemDefault_acs_rds_dashboard_IOPSUsage",
      "Period" : 300,
      "Dimensions" : "",
      "EffectiveInterval" : "",
      "Namespace" : "acs_rds_dashboard",
      "AlertState" : "INSUFFICIENT_DATA",
      "MetricName" : "IOPSUsage",
      "EnableState" : true,
      "Escalations" : {
        "Critical" : { },
        "Info" : {
          "ComparisonOperator" : "GreaterThanThreshold",
          "Times" : 5,
          "Statistics" : "Average",
          "Threshold" : "80"
        },
        "Warn" : { }
      },
      "Webhook" : "",
      "Resources" : "[{\"resource\":\"_ALL\"}]",
      "RuleName" : "SystemDefault_acs_rds_dashboard_IOPSUsage"
    }, {
      "SilenceTime" : 86400,
      "ContactGroups" : "ECS_Group",
      "NoEffectiveInterval" : "",
      "MailSubject" : "${serviceType}-${metricName}-${levelDescription}",
      "RuleId" : "SystemDefault_acs_rds_dashboard_CpuUsage",
      "Period" : 300,
      "Dimensions" : "",
      "EffectiveInterval" : "",
      "Namespace" : "acs_rds_dashboard",
      "AlertState" : "INSUFFICIENT_DATA",
      "MetricName" : "CpuUsage",
      "EnableState" : true,
      "Escalations" : {
        "Critical" : { },
        "Info" : {
          "ComparisonOperator" : "GreaterThanThreshold",
          "Times" : 5,
          "Statistics" : "Average",
          "Threshold" : "80"
        },
        "Warn" : { }
      },
      "Webhook" : "",
      "Resources" : "[{\"resource\":\"_ALL\"}]",
      "RuleName" : "SystemDefault_acs_rds_dashboard_CpuUsage"
    } ]
  },
  "Datapoints" : {
    "Alarm" : [ {
      "SilenceTime" : 86400,
      "ContactGroups" : "[\"Alice\"]",
      "ComparisonOperator" : "GreaterThanThreshold",
      "EndTime" : "",
      "RuleId" : "SystemDefault_acs_rds_dashboard_IOPSUsage",
      "StartTime" : "",
      "Period" : 300,
      "EvaluationCount" : 5,
      "Statistics" : "Average",
      "Namespace" : "acs_rds_dashboard",
      "MetricName" : "IOPSUsage",
      "State" : "INSUFFICIENT_DATA",
      "Enable" : true,
      "Webhook" : "",
      "RuleName" : "SystemDefault_acs_rds_dashboard_IOPSUsage",
      "Threshold" : "80"
    }, {
      "SilenceTime" : 86400,
      "ContactGroups" : "[\"Jim\"]",
      "ComparisonOperator" : "GreaterThanThreshold",
      "EndTime" : "",
      "RuleId" : "SystemDefault_acs_rds_dashboard_CpuUsage",
      "StartTime" : "",
      "Period" : 300,
      "EvaluationCount" : 5,
      "Statistics" : "Average",
      "Namespace" : "acs_rds_dashboard",
      "MetricName" : "CpuUsage",
      "State" : "INSUFFICIENT_DATA",
      "Enable" : true,
      "Webhook" : "",
      "RuleName" : "SystemDefault_acs_rds_dashboard_CpuUsage",
      "Threshold" : "80"
    } ]
  },
  "Code" : "200",
  "Success" : true
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
404	ResourceNotFound	The specified resource is not found.	La ressource spécifiée est introuvable.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.