Evénements

Sommaire
casp1032
Utilisez la ressource events pour créer des événements.
La ressource events opère sur un ou plusieurs groupes de modèles.
  • URL de base
    http://<hostname><:portnumber>/spectrum/restful/events
POST event
POST event crée un événement.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/events/<eventType>/model/<model_handle>[?varbind=<varbind id>][&val=<varbind value>]
  • HTTP Method (Méthode HTTP)
    POST
  • Body (Corps)
    Aucun
  • Body Content (Contenu du corps)
    Non utilisé
  • Header (En-tête)
    application/xml, application/json
  • Encoding (Codage)
    UTF-8
  • Output (Sortie)
    Fichier XML ou JSON qui répertorie le descripteur du modèle créé ou l’erreur si le modèle ne peut pas être créé.
URL Parameters (Paramètres d'URL)
  • <eventType>
    Spécifie le type d’événement à créer.
  • <model_handle>
    Spécifie le descripteur de modèle avec lequel l’événement sera créé.
  • <varbind id>
    Spécifie l’ID de varbind.
  • <varbind value>
    Spécifie la valeur de varbind.
POST events
Utilisez POST events pour créer un ou plusieurs événements sur un ou plusieurs modèles. L’envoi d’une demande POST events vous permet de fournir un document XML qui spécifie les événements à créer ainsi que les modèles pour la création. Le document contient une liste des descripteurs de modèle, des critères de recherche XML ou une référence aux critères de recherche existants sur le serveur OneClick.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/events
  • HTTP Method (Méthode HTTP)
    POST
  • Body (Corps)
    Des exemples sont fournis dans <$SPECROOT>/RestfulExamples/xml/Events. Ces fichiers XML fournissent des exemples de XML correctement formés à des fins différentes. Utilisez ces exemples comme référence pour votre propre fichier XML :
    • CreateEventByModelHandleList.xml
    • CreateEventByModelSearch.xml
    • CreateMultipleEventsByModelHandle.xml
  • Body Content (Contenu du corps)
    application/xml
  • Header (En-tête)
    application/xml, application/json
  • Encoding (Codage)
    UTF-8
  • Output (Sortie)
    Liste XML ou JSON de modèles répondant aux demandes d’entrée dans le serveur SpectroSERVER ou dans le serveur Distributed SpectroSERVER
Exemple : création d’un événement 0x10f06 sur tous les types de modèles RTR_Cisco avec 4 varbinds
L'exemple suivant présente la création d’un événement 0x10f06 sur tous les types de modèles RTR_Cisco avec 4 varbinds.
  • URL
Publiez le corps XML suivant sur :
http://<hostname><:portnumber>/spectrum/restful/events
  • Body (Corps)
<?xml version="1.0" encoding="UTF-8"?> <!--This sample event request will create an event of type 0x10f06 (generates a High Memory Utilization alarm) on all models found by the specified locater search (all models derived from RTR_Cisco) --> <rs:event-request throttlesize="10" xmlns:rs="http://www.ca.com/spectrum/restful/schema/request" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ca.com/spectrum/restful/schema/request ../../../xsd/Request.xsd"> <rs:event> <rs:target-models> <rs:models-search> <rs:search-criteria xmlns="http://www.ca.com/spectrum/restful/schema/filter"> <filtered-models> <is-derived-from> <attribute id="AttributeID.MTYPE_HANDLE"> <value>0x21000c</value> <!-- RTR_Cisco --> </attribute> </is-derived-from> </filtered-models> </rs:search-criteria> </rs:models-search> </rs:target-models> <!-- event ID --> <rs:event-type id="0x10f06"/> <!-- attributes/varbinds --> <rs:varbind id="0">75</rs:varbind> <rs:varbind id="1">99</rs:varbind> <rs:varbind id="3">mem_instance</rs:varbind> <rs:varbind id="5">name</rs:varbind> </rs:event> </rs:event-request>
POST events (GET Tunneling)
Cette API est utilisée pour récupérer les événements d’un descripteur de modèle.
Cette API est uniquement prise en charge sur les modèles d’unité.
Attributes (Attributs)
Description
model handle
Spécifie les descripteurs de modèle d’unité pour récupérer les événements.
start time and end time
Spécifie les heures de début et de fin au format de l’époque.
subcomponents events
Spécifie les événements pour les sous-composants. Défini sur true si des événements de sous-composants sont requis.
exclude events
Spécifie les événements exclus. Les événements sont séparés par une virgule.
tags
Indique que les attributs demandés peuvent être personnalisés en fonction de la préférence de l’utilisateur : plus ou moins d’attributs peuvent être requis.
landscape
Un seul paysage peut être pris en charge.
null
Des attributs de valeur nulle seront renvoyés s’il n’existe aucune valeur existante pour l’attribut.
  • URL
    http://ocserver:portnumber/spectrum/restful/events/getEvents
  • HTTP Method (Méthode HTTP)
    POST
  • Exemple de corps ou de charge utile
    <?xml version="1.0" encoding="UTF-8"?>
    <rs:get-event-request throttlesize="10"
    xmlns:rs="http://www.ca.com/spectrum/restful/schema/request"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.ca.com/spectrum/restful/schema/request ../../../xsd/Request.xsd ">
    <rs:get-events-filter
    start-time="1522640184000"
    end-time="1522644324000"
    subcomponents-events="false"
    exclude-events="0x10005,0x10219,0x10706"
    />
    <rs:requested-attribute id="0x11f56"/> <!--Alarm Severity -->
    <rs:requested-attribute id="0x11f4e"/> <!-- Created On -->
    <rs:requested-attribute id="0x129fa"/> <!-- MODEL_HANDLE -->
    <rs:requested-attribute id="0x1006e"/> <!-- Name -->
    <rs:requested-attribute id="0x4820007"/> <!-- Event -->
    <rs:requested-attribute id="0x11fb9"/> <!-- Created By -->
    <rs:requested-attribute id="0x482001b"/> <!--Alarm Cleared On -->
    <rs:requested-attribute id="0x482001c"/> <!--Alarm Cleared By -->
    <rs:requested-attribute id="0x10000"/> <!-- Model type Name -->
    <rs:requested-attribute id="0x11fb8"/> <!-- Event Type -->
    <rs:requested-attribute id="0x12c0a"/> <!-- Event Precedence -->
    <!-- Models of Interest -->
    <rs:target-models>
    <rs:model mh="0x800258"/>
    <!--<rs:model mh="0x100934"/>-->
    <!-- <rs:model mh="0x1000089"/>-->
    </rs:target-models>
    <rs:landscape id="0x800000" />
    </rs:get-event-request>
  • Exemple de réponse
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <get-event-response-list xmlns="http://www.ca.com/spectrum/restful/schema/response" total-events="30" throttle="2">
    <get-event-responses>
    <event id="5abe765b-e8a1-100c-0437-0050568c73e5">
    <attribute id="0x11f56">3</attribute>
    <attribute id="0x11f4e">1522431579</attribute>
    <attribute id="0x129fa">0x1009ae</attribute>
    <attribute id="0x1006e">Cisco7606-96.37.37.ca.com</attribute>
    <attribute id="0x4820007">Device Cisco7606-96.37.37.ca.com of type Rtr_Cisco has stopped responding to polls and/or external requests. An alarm will be generated.</attribute>
    <attribute id="0x11fb9">System</attribute>
    <attribute id="0x482001b">1522432925</attribute>
    <attribute id="0x482001c">System</attribute>
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x11fb8">0x10d35</attribute>
    <attribute id="0x12c0a">10</attribute>
    </event>
    <event id="5abe765b-e8a3-100c-0437-0050568c73e5">
    <attribute id="0x11f56">null</attribute> , null will be retuned if there is no value exists for the attribute
    <attribute id="0x11f4e">1522431579</attribute>
    <attribute id="0x129fa">0x1009ae</attribute>
    <attribute id="0x1006e">Cisco7606-96.37.37.ca.com</attribute>
    <attribute id="0x4820007">Alarm number 845986 with probable cause id 0x10009 generated for device Cisco7606-96.37.37.ca.com of type Rtr_Cisco. The severity of this alarm is CRITICAL.</attribute>
    <attribute id="0x11fb9">System</attribute>
    <attribute id="0x482001b">null</attribute>
    <attribute id="0x482001c">null</attribute>
    <attribute id="0x10000">Rtr_Cisco</attribute>
    <attribute id="0x11fb8">0x10701</attribute>
    <attribute id="0x12c0a">10</attribute>
    </event>
    </get-event-responses>
    <link type="application/xml" href="http://ocserver-portnumber/spectrum/restful/events/getEvents?id=cdf7caef-9c4a-4f28-9270-6b4b8e87feb6&amp;start=2&amp;throttlesize=2" rel="next"/>
    </get-event-response-list>
  • Body Content (Contenu du corps)
    application/xml, application
  • Header (En-tête)
    application/xml, application/json
  • Output (Sortie)
    Liste XML ou JSON de modèle-réponse indiquant la réussite ou l’échec de chaque mise à jour.