Manuel de référence de l'API de surveillance
CA AppLogic®
3.7
Vous pouvez collecter des données de compteur et de configuration des appliances connectées à l'appliance MON en envoyant des demandes HTTP GET au terminal d'entrée auxiliaire de l'appliance MON. Vous effectuez cette collecte via le protocole REST personnalisé, qui s'exécute sur HTTP. Ce protocole définit trois types de ressources :
Chacun de ces types est intégré dans la portée du précédent. Cela signifie que les entités ne sont pertinentes que dans la portée des appliances et que les compteurs n'ont de sens que dans la portée d'une entité particulière. L'API de collecte de données permet de récupérer toutes les valeurs et les configurations de compteur connues de MON.
MON exporte les configurations de données et valeurs demandées dans un des formats de texte structurés suivants :
Le protocole utilise uniquement la méthode GET HTTP, puisqu'il offre seulement une fonctionnalité de lecture. Ainsi, tous les types de requêtes de protocole pris en charge peuvent être définis au moyen de leur URI et de la structure de sortie. Les caractères considérés comme spéciaux pour l'URI doivent être échappés à l'aide du codage standard %. La sortie se définit par son schéma XML (le format de sortie principal est XML). La conversion dans d'autres formats de sortie (UDL, JSON) est obtenue par l'utilisation directe des moyens d'expression de la structure et des attributs du format de sortie respectif (par exemple entités UDL/ entités XML, attributs UDL/ attributs XML, objets JSON/ entités XML, propriétés d'objet JSON/ attributs XML).
Le noeud racine de toutes les sorties contient l'attribut d'horodatage qui indique l'heure du serveur au moment de la création de la réponse.
Vous trouverez ci-dessous une description de toutes les URL prises en charge (appels).
Appels de configuration de compteur
/monapi/desc[?fmt=<format>]
Renvoie une liste de toutes les appliances disponibles dans un format de sortie spécifié (<format> est l'un des formats de sortie connus, par exemple XML).
Sortie :
<response timestamp="1194967464"> <appliance name="main.web" /> <appliance name="main.in" /> </response>
/monapi/desc/<apps>[?fmt=<format>]
Renvoie la liste de toutes les entités disponibles dans les appliances demandées (<apps>). <Apps> peut être un nom d'appliance unique, une liste séparée par des virgules de noms d'appliance ou un caractère générique (*) qui signifie que toutes les appliances sont disponibles.
Sortie :
<response timestamp="1194967464">
<appliance name="main.web">
<entity name="Terminal in" />
<entity name="Terminal out" />
<entity name="Volume data" />
<entity name="CPU" />
<entity name="Memory" />
<entity name="Network" />
</appliance>
</response>
/monapi/desc/<apps>/<ents>[?fmt=<format>]
Renvoie la liste de tous les compteurs disponibles dans les appliances demandées (<ents>). (<ents>) peut être un nom d'entité unique, une liste séparée par des virgules de noms d'entités ou un caractère générique (*) qui correspond à toutes les entités disponibles. Identique pour <apps>.
Sortie :
<response timestamp="1194967464">
<appliance name="main.web">
<entity name="Terminal in">
<counter name="Sent bytes" />
<counter name="Received bytes" />
</entity>
</appliance>
</response>
/monapi/desc/<apps>/<ents>/<cnts>[?fmt=<format>]
Renvoie les descriptions des compteurs demandés (<cnts>). <ents>, <ents> et <ents> peut être un(e) appliance/entité/compteur unique, une liste séparée par des virgules de ces derniers ou un caractère générique.
Sortie :
<response timestamp="1194967464">
<appliance name="main.web">
<entity name="Terminal in">
<counter name="Sent bytes" description="" units="" alarm_below="" alarm_above="" range_lower="" range_upper="" pace="" />
<counter name="Received bytes" description="" units="" alarm_below="" alarm_above="" range_lower="" range_upper="" pace="" />
</entity>
</appliance>
</response>
Appels de valeur de compteur
/monapi/val/<apps>/<ents>/<cnts>[?fmt=<format>]
Renvoie les valeurs des compteurs spécifiés. Si l'un des paramètres app, ent ou cnt est ignoré, le système utilise la valeur de caractère générique. Ainsi, /monapi/val/main.web signifie : les valeurs de tous les compteurs dans toutes les entités de l'appliance main.web.
Sortie :
<response timestamp="1194967464">
<appliance name="main.web">
<entity name="Terminal in">
<counter name="Sent bytes" value="23234" />
<counter name="Received bytes" value="690432" />
</entity>
</appliance>
</response>
|
Copyright © 2013 CA.
Tous droits réservés.
|
|