DescribeEventRuleList - - Centre de documentation Alibaba Cloud

Consulte les règles d'alerte déclenchées par des événements.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
NamePrefix	string	Non	Le préfixe du nom de la règle d'alerte déclenchée par des événements.	test
PageNumber	string	Non	Le numéro de page. Les pages commencent à la page 1. Valeur par défaut : 1.	1
PageSize	string	Non	Le nombre d'entrées par page. Les pages commencent à la page 1. Valeur par défaut : 10.	10
GroupId	string	Non	L'identifiant du groupe d'applications.	7378****
IsEnable	boolean	Non	Indique si la règle d'alerte déclenchée par des événements doit être activée. Valeurs valides : true (par défaut) false	true

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les règles d'alerte déclenchées par des événements.
Code	string	Le code d'état HTTP. Remarque Le code d'état 200 indique que la requête a réussi.	200
Message	string	Le message d'erreur renvoyé.	Utilisateur non autorisé à effectuer des opérations sur la ressource spécifiée
RequestId	string	L'identifiant de la requête.	D0E6D82B-16B5-422A-8136-EE5BDC01E415
Total	integer	Le nombre total d'entrées renvoyées.	21
Success	boolean	Indique si la requête a réussi. Valeurs valides : true false	true
EventRules	object
EventRule	array<object>	La règle d'alerte déclenchée par des événements.
	array<object>
EventType	string	The type of the event-triggered alert rule. Valid values: SYSTEM: system event-triggered alert rule CUSTOM: custom event-triggered alert rule	SYSTEM
Description	string	The description of the event-triggered alert rule.	Default group event rule.
GroupId	string	The ID of the application group.	7378****
Name	string	The name of the event-triggered alert rule.	test_DefaultEventRule_7378****
State	string	The status of the event-triggered alert rule. Valid values: ENABLED DISABLED	ENABLED
EventPattern	object
EventPattern	array<object>	The mode of the event-triggered alert rule.
	array<object>
Product	string	The abbreviation of the Alibaba Cloud service name.	CloudMonitor
LevelList	object
LevelList	array	The levels of the event-triggered alerts.
	string	The level of the event-triggered alert. Valid values: CRITICAL WARN INFO	CRITICAL
EventTypeList	object
EventTypeList	array	The types of the event-triggered alert rules.
	string	The type of the event-triggered alert rule. `*` indicates all types of alert rules.	*
NameList	object
NameList	array	The event names.
	string	The event name.	["Agent_Status_Stopped"]
CustomFilters	string	The custom filter conditions.	ECS123
KeywordFilter	object	The keyword for filtering.
Keywords	object
Keywords	array	The keywords that are used to match events.
	string	The keyword.	VMException
Relation	string	The relationship between multiple keywords in a condition. Valid values: OR: The relationship between keywords is OR. NOT: The keyword is excluded. The value NOT indicates that all events that do not contain the keywords are matched.	OR
SQLFilter	string	Indicates that logs are filtered based on the specified SQL statement. If the specified conditions are met, an alert is triggered.	ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222
SilenceTime	integer	The mute period during which new alert notifications are not sent even if the trigger conditions are met.	86400

Exemples

JSON format

{
  "Code": "200",
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "D0E6D82B-16B5-422A-8136-EE5BDC01E415",
  "Total": 21,
  "Success": true,
  "EventRules": {
    "EventRule": [
      {
        "EventType": "SYSTEM",
        "Description": "Default group event rule.",
        "GroupId": "7378****",
        "Name": "test_DefaultEventRule_7378****",
        "State": "ENABLED",
        "EventPattern": {
          "EventPattern": [
            {
              "Product": "CloudMonitor",
              "LevelList": {
                "LevelList": [
                  "CRITICAL"
                ]
              },
              "EventTypeList": {
                "EventTypeList": [
                  "*"
                ]
              },
              "NameList": {
                "NameList": [
                  "[\"Agent_Status_Stopped\"]"
                ]
              },
              "CustomFilters": "ECS123",
              "KeywordFilter": {
                "Keywords": {
                  "Keywords": [
                    "VMException"
                  ]
                },
                "Relation": "OR"
              },
              "SQLFilter": "ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222"
            }
          ]
        },
        "SilenceTime": 86400
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameterValue	Illegal parameters.	Illegal parameters.
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

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

Notes de version

Consultez Notes de version pour la liste complète.