Lista de API de alarmas


ManageEngine Applications Manager proporciona la API de listas de alarmas que  permite al usuario enumerar la información sobre alarmas recientes en un formato XML. Las API de alarma se enumeran a continuación.

  • Listado de todas las alarmas recientes
  • Listado de todas las alarmas críticas recientes
  • Listado de todas las alarmas de advertencia recientes
  • Listado de todas las alarmas recientes claras
  • Listado de alarmas recientes por filtro de tiempo
  • Listado de alarmas por tipo de monitor
  • Listado de alarmas por monitor resourceid
  • Listado de alarmas por top N
  • Listado de alarmas reconocidas

Esta API listará todas las alarmas de los monitores configurados en el Administrador de Aplicaciones para el usuario correspondiente a la Clave API. Estos detalles incluirán el estado y la disponibilidad de los tipos de monitores, el tipo de imagen, las interrupciones del estado, el recuento crítico / advertencia / borrado / ascendente / descendente para cada tipo de monitor.

API para ListAlarms

  • Listado de todas las alarmas

http: // [Host]: [Puerto] / AppManager / xml / ListAlarms? apikey = [clave API] & type = all

  • Listado de todas las alarmas críticas recientes

http: // [Host]: [Port] / AppManager / xml / ListAlarms? apikey = [API key] & type = critic

  • Listado de todas las alarmas de advertencia recientes

http: // [Host]: [Port] / AppManager / xml / ListAlarms? apikey = [API key] & type = warning

  • Listado de todas las alarmas recientes claras

http: // [Host]: [Port] / AppManager / xml / ListAlarms? apikey = [API key] & type = clear

  • Lista de alarmas recientes después de un tiempo especificado.

http: // [Host]: [Port] / AppManager / xml / ListAlarms? apikey = [API key] & time = [Time]

  • Listado de alarmas por nombre de monitor

http: // [Host]: [Port] / AppManager / xml / ListAlarms? apikey = [API key] & resourceid = [resourceid]

  • Listado de alarmas por tipo de monitor

http: // [Host]: [Port] / AppManager / xml / ListAlarms? apikey = [API key] & type = [TYPE]

  • Listado de alarmas por top N

http: // [Host]: [Puerto] / AppManager / xml / ListAlarms? apikey = [clave API] & topN = [XYZ]

  • Listado de alarmas por grupo

http: // [Host]: [Puerto] / AppManager / xml / ListAlarms? apikey = [API key] & groupName = Administrador de aplicaciones

  • Listado de todas las alarmas excluyendo grupos de monitores

http: // [Host]: [Puerto] / AppManager / xml / ListAlarms? apikey = [clave API] & type = allmonitors

  • Listado de alarmas reconocidas

http: // [Host]: [Puerto] / AppManager / xml / ListAlarms? apikey = [clave API] & RecogngedAlerts = [true / false]

 

Nota:
a) Para obtener todas las alarmas necesitamos pasar ' type = all ' .... es obligatorio.
b) Para una combinación de severidad de alarmas, por ejemplo: podemos pasar ' crítico, advertencia ' como un valor para que el tipo obtenga tanto crítico como advertencia.

Solicitar parámetros

Campo Descripción        
Clave API La clave generada a partir de la  opción "Generar API"  en la pestaña Administrador.
resourceid "resourceid = [resourceid of monitor]"  se utiliza para enumerar las alarmas de un monitor en particular.
Tipo
"type = all"  se utiliza para enumerar todas las alarmas.
"tipo = crítico"  se utiliza para enumerar todas las alarmas críticas.
"tipo = advertencia"  se utiliza para enumerar todas las alarmas de advertencia.
"type = clear"  se utiliza para enumerar todas las alarmas de borrado.
"type = [Tipo de monitor]"  se usa para listar alarmas por tipo de monitor donde <tipo de monitor> es TYPE en la tabla AM_ManagedObject como Linux, Windows XP, MYSQL-DB-server, Apache-server, UrlMonitor, Tomcat-server, etc.
Top N "topN = [N]"  se utiliza para enumerar las N principales alarmas.
Hora "time = [Time]"  se utiliza para enumerar las alarmas generadas después del tiempo especificado.
<Time>  se repite en milisegundos.
alertas reconocidas Enumera las alarmas reconocidas o no reconocidas. ( verdadero o falso )

Atributos extra:

DISPONIBILIDAD SEVERIDAD Esta es la gravedad de la disponibilidad del monitor (1: crítico, 5 claro)
SEVERIDAD DE SALUD (anteriormente conocida como SEVERIDAD) Esta es la gravedad del monitor para la salud (1 crítico, 4 de advertencia y 5 claro)
TÉCNICO Este valor especifica el técnico que ha reconocido / recogido la alarma generada para este monitor.
ANOTACIÓN Este valor es la anotación agregada con respecto a la alarma generada para este monitor.
DetailsPageURL Este valor es el enlace a la página de detalles del monitor para el que se genera la alarma.

Sintaxis

API para respuesta XML: 

http: // [APM Host]: [APM Port] / AppManager / xml / ListAlarms? apikey = [API Key] & type = all

API para respuesta JSON: 

http: // [APM Host]: [APM Port] / AppManager / json / ListAlarms? apikey = [API Key] & type = '' crítico, claro '

API de ejemplo que se utiliza para obtener XML de todos los detalles de las alarmas recientes:

http: // app-windows: 9090 / AppManager / xml / ListAlarms? apikey = 65d0fa3e1f6c6bdcce1c3969f24c39a

Parámetros de respuesta

Campo Descripción        
Detalles de alarma
NOMBRE PARA MOSTRAR Nombre para mostrar del monitor como Linux-1
RECURSOS ID de recurso del monitor
SALUD SEVERIDAD Esta es la gravedad del monitor para la salud (1 crítico, 4 de advertencia y 5 claro)
MENSAJE Mensaje de alarma como 'El recurso está inactivo. La salud es fundamental ya que el recurso no está disponible '
ID DE ATRIBUTO ID de atributo del estado del monitor
MODTIME Hora en que se generó la alarma (ms)
ESTADO Claro / Advertencia / Crítico: estado de la alarma
TIPO Tipo de monitor como Linux
TYPEDISPLAYNAME Nombre para mostrar del tipo como 'Linux'
DISPONIBILIDAD SEVERIDAD Esta es la gravedad de la disponibilidad del monitor (1: crítico, 5 claro)
TÉCNICO Este valor especifica el técnico que ha reconocido / recogido la alarma generada para este monitor.
ANOTACIÓN Este valor es la anotación agregada con respecto a la alarma generada para este monitor.
DetailsPageURL Este valor es el enlace a la página de detalles del monitor para el que se genera la alarma.

Respuesta de ejemplo

<AppManager-response uri = "/ AppManager / xml / ListAlarms">
<result>
<response response-code = "4000">
<Alarm DISPLAYNAME = "DB2" MODTIME = "1333012233887" AVAILABILITYSEVERITY = "5" ATTRIBUTEID = "2601" TECHNICIAN = "None"
STATUS = "warning" MESSAGE = "El estado de DB2 es una advertencia. <br> Causa raíz: <br> 1. Tiempo de conexión 1504> 1500 ms (umbral). <br>"
ANNOTATION = "YES" RESOURCEID = "10001307" TYPE = "DB2-server" DetailsPageURL = "/ showresource.do?resourceid=10001307&method=showResourceForResourceID&PRINTER_FRIENDLY=true"
TYPEDISPLAYNAME = "DB2"SHORTMESSAGE = "La salud es una advertencia" HEALTHSEVERITY = "4" />
</response>
</result>
</AppManager-response>

API de ejemplo que se utiliza para obtener XML de todos los detalles de alarmas recientes que se generan después de un tiempo en particular:

http: // app-windows: 9090 / AppManager / xml / ListAlarms? apikey = 65d0fa3e1f6c6bdcce1c3969f24c39a8 & time = 1248868798412