Guide di integrazione › Guida di riferimento delle API di monitoraggio

Guida di riferimento delle API di monitoraggio

CA AppLogic®

3.7

Panoramica delle API di monitoraggio

È possibile raccogliere i dati dei contatori e la configurazione per le appliance connesse all'appliance MON inviando richieste HTTP GET al terminale di input aux dell'appliance MON. La connessione avviene mediante un protocollo personalizzato basato su REST in esecuzione su HTTP. Tale protocollo definisce tre tipi di risorse:

• Appliance
• Entità
• Contatori

Ciascuno di questi tipi è incorporato nell'ambito del precedente. In questo modo le entità risultano significative solo nell'ambito delle appliance e i contatori solo nell'ambito di una determinata entità. L'API per la raccolta dei dati consente di recuperare tutti i valori e le configurazioni dei contatori noti a MON.

MON esporta i valori e le configurazione di dati richiesti in uno dei seguenti formati di testo strutturati:

• XML (formato principalmente utilizzato se non viene richiesto un formato specifico per mezzo dell'argomento Fmt)
• UDL (destinato a un utilizzo interno di CA AppLogic®)
• JSON (destinato a client browser con JavaScript abilitato)

Protocollo delle API di monitoraggio

Il protocollo utilizza solamente il metodo HTTP GET, in quanto fornisce una funzionalità di sola lettura. Per questo motivo ogni tipo di richiesta di protocollo supportato può essere definito per mezzo dell'URI e della struttura di output. Caratteri considerati speciali per l'URI devono essere preceduti da un carattere di escape utilizzando la codifica standard %. L'output viene definito in base al relativo schema XML (il formato di output principale è XML). La conversione in altri formati di output (UDL, JSON) si ottiene utilizzando direttamente i mezzi per esprimere la struttura e gli attributi del rispettivo formato di output (ad esempio entità UDL al posto di entità XML, attributi UDL al posto di attributi XML, oggetti JSON al posto di entità XML, proprietà oggetto JSON al posto di attributi XML).

Il nodo principale di tutti gli output contiene un attributo Data/Ora che fornisce la data e l'ora del server nel momento in cui viene creata la risposta.

Quanto segue è una descrizione di tutti gli URL supportati (chiamate).

Chiamate di configurazione dei contatori

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

Fornisce un elenco di tutte le appliance disponibili nel formato di output specificato (<format> indica uno dei formati di output noti, ad esempio XML).

Output:

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

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

Restituisce un elenco di tutte le entità disponibili nell'appliance richiesta (<apps>). <apps> potrebbe essere un nome di appliance singolo, un elenco di nomi di appliance separati da virgola o un carattere jolly (*) che indica tutte le appliance disponibili.

Output:

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

Restituisce un elenco di tutti i contatori disponibili nelle entità di appliance richieste (<ents>). <ents> potrebbe corrispondere a un nome di entità singolo, un elenco di nomi di entità separati da virgola o un carattere jolly (*), il quale indica tutte le entità disponibili. Lo stesso vale per <apps>.

Output:

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

Restituisce le descrizioni dei contatori richiesti (<cnts>). <ents>, <ents> e <ents> possono essere un'appliance/entity/counter unico, un elenco separato da virgola di questo o carattere jolly.

Output:

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

Chiamate di valore dei contatori

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

Restituisce i valori dei contatori specificati. Se viene omesso uno dei parametri app, ent o cnt, viene utilizzato il valore del carattere jolly. Pertanto, ad esempio, /monapi/val/main.web significa "i valori di tutti i contatori in tutte le entità dell'appliance main.web ".

Output:

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