Integrationshandbücher › Referenzhandbuch zur Überwachungs-API

Referenzhandbuch zur Überwachungs-API

CA AppLogic®

3.5

Überwachungs-API – Übersicht

Die MON-Appliance exportiert Zähler- und Konfigurationsdaten von über das AUX-Ausgabe-Terminal verbundenen Appliances. Dies geschieht über ein benutzerdefiniertes Protokoll auf REST-Basis über HTTP. Dieses Protokoll definiert 3 Typen von Ressourcen:

• Appliances
• Entitäten
• Zähler

Jeder dieser Typen ist im Kontext des vorangehenden Typs zu verstehen, d. h. Entitäten haben nur innerhalb von Appliances Bedeutung, und Zähler haben nur innerhalb einer bestimmten Entität Bedeutung. Die Datenerfassungs-API ermöglicht das Abrufen aller Zählerkonfigurationen und Werte, die MON bekannt sind.

MON exportiert angeforderte Datenkonfigurationen und Werte in einem der folgenden strukturierten Textformate:

• XML (primäres Format; wird verwendet, wenn kein bestimmtes Format über das "fmt"-Argument angefordert wird)
• UDL (für die innerbetriebliche Verwendung von CA AppLogic)
• JSON (für JavaScript-fähige Browserclients)

Überwachungs-API-Protokoll

Das Protokoll verwendet nur die HTTP-Methode GET, da es nur über Lesefunktionen verfügt. So kann jeder unterstützte Protokollanfragetyp über seine URI und die Ausgabestruktur definiert werden. Zeichen, die in der URI als Sonderzeichen gelten, sollten mit der standardmäßigen %-Kodierung maskiert werden. Die Ausgabe wird nach ihrem XML-Schema definiert (das primäre Ausgabeformat ist XML). Die Übersetzung in andere Ausgabeformate (UDL, JSON) wird durch die direkte Verwendung des Struktur- und Attributschemas des jeweiligen Ausgabeformats erreicht (zum Beispiel UDL-Entitäten vs. XML-Entitäten, UDL-Attribute vs. XML-Attribute, JSON-Objekte vs. XML-Entitäten, JSON-Objekteigenschaften vs. XML-Attribute).

Der Stammknoten aller Ausgaben enthält ein Zeitstempelattribut, das die Serverzeit zum Erstellungszeitpunkt der Antwort angibt.

Es folgt eine Beschreibung aller unterstützten URLs (Aufrufe).

Zählerkonfigurationsaufrufe

/monapi/desc[?fmt=<format>] 

Gibt eine Liste aller verfügbaren Appliances in einem bestimmten Ausgabeformat zurück (<format> steht für eines der bekannten Ausgabeformate, zum Beispiel XML).

Ausgabe:

<response timestamp="1194967464">
   <appliance name="main.web" />
   <appliance name="main.in" />
</response>

/monapi/desc/<apps>[?fmt=<format>] 

Gibt eine Liste von allen verfügbaren Entitäten innerhalb der angeforderten Appliances zurück (<apps>). <apps> könnte ein einzelner Appliance-Name, eine durch Komma getrennte Liste von Appliance-Namen oder ein Platzhalterzeichen sein, wobei (*) alle verfügbaren Appliances bedeuten.

Ausgabe:

<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>] 

Gibt eine Liste aller verfügbaren Zählern innerhalb der angeforderten Appliance-Entitäten zurück (<ents>). <ents> könnte ein einzelner Entitätsname, eine durch Komma getrennte Liste von Entitätsnamen oder ein Platzhalterzeichen sein, wobei (*) alle verfügbaren Entitäten bedeuten. Das Gleiche gilt für <apps>.

Ausgabe:

<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>] 

Gibt die Beschreibungen der angeforderten Zähler zurück (<cnts>). <ents>, <ents> und <ents> könnte eine einzelne Appliance/Entität, ein einzelner Zähler oder eine durch Komma getrennte Liste dieser Platzhalter sein.

Ausgabe:

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

Zählerwertaufrufe

/monapi/val/<apps>/<ents>/<cnts>[?fmt=<format>] 

Gibt die Werte der angegebenen Zähler zurück. Wenn einer der Parameter (für Appliances, Entitäten oder Zähler) ausgelassen wird, wird ein Wildcard-Wert angenommen. So bedeutet beispielsweise /monapi/val/main.web "die Werte aller Zähler aller Entitäten der "main.web"-Appliance".

Ausgabe:

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