Guías de integración › Guía de referencia de la API de control

Guía de referencia de la API de control

CA AppLogic®

3.7

Descripción general de la API de monitorización

Se pueden recopilar datos de contador y la configuración para los dispositivos conectados al dispositivo MON enviando solicitudes HTTP GET al terminal de entrada auxiliar del dispositivo MON. Esto se lleva a cabo mediante un protocolo personalizado basado en REST que se ejecuta a través de HTTP. Este protocolo define tres tipos de recursos:

• Dispositivos
• Entidades
• Contadores

Cada uno de estos tipos está integrado en el ámbito del anterior. Es decir, las entidades solo tienen significado en el ámbito de los dispositivos y los contadores solo son significativos en el ámbito de una entidad determinada. La API de recolección de datos permite recuperar todas las configuraciones de los contadores, así como los valores conocidos para MON.

MON exporta la configuración y los valores solicitados en cualquiera de los formatos de texto estructurado siguientes:

• XML (formato primario que se utiliza si no se solicita ningún formato específico a través del argumento fmt).
• UDL (indicado para uso interno de CA AppLogic®)
• JSON (indicado para clientes de explorador JavaScript)

Protocolo de API de monitorización

Este protocolo únicamente utiliza el método GET HTTP, ya que sólo proporciona funcionalidad de lectura. Por ello, todos los tipos de solicitudes de protocolo compatibles se pueden definir mediante su URI y la estructura de salida. Los caracteres que se consideran especiales para el URI se deben escapar mediante la codificación % estándar. Definimos la salida mediante el esquema XML (el formato de salida principal es XML). La conversión a otros formatos de salida (UDL, JSON) se logra a través del uso directo del medio expresión de la estructura y los atributos del formato de salida correspondiente (por ejemplo entidades UDL frente a entidades XML, atributos UDL frente a atributos XML, objetos JSON frente a entidades XML, propiedades de objetos JSON frente a atributos XML).

El nodo raíz de todas las salidas contiene el atributo de marca de hora que proporciona la hora del servidor en el momento en que se crea la respuesta.

La siguiente es una descripción de todas los URL compatibles (llamadas).

Llamadas de configuración del contador

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

Devuelve una lista de todos los dispositivos disponibles en un formato de salida especificado (<format> es uno de los formatos de salida conocidos como, por ejemplo, xml).

Salida:

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

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

Devuelve una lista de todas las entidades disponibles dentro de los dispositivos solicitados (<apps>). <apps> puede ser un solo nombre de dispositivo, una lista de nombres de dispositivo separada por comas o un carácter comodín (*) que significa todos los dispositivos disponibles.

Salida:

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

Devuelve una lista de todos los contadores disponibles dentro de las entidades de dispositivo solicitadas (<ents>). <ents> puede ser un solo nombre de entidad, una lista de nombres de entidad separada por comas o un carácter comodín (*) que significa que son todas las entidades disponibles. Lo mismo para <apps>.

Salida:

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

Devuelve las descripciones de los contadores solicitados (<cnts>). <ents>, <ents> y <ents> pueden ser un solo dispositivo/entidad/contador, una lista de éstos separada por comas o un carácter comodín.

Salida:

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

Llamadas de valores del contador

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

Devuelve los valores de los contadores especificados. Si alguno de los parámetros app, ent o cnt se omite, se asume el valor del carácter comodín. De esta forma, por ejemplo /monapi/val/main.web significaría "los valores de todos los contadores en todas las entidades del dispositivo main.web".

Salida:

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