列出告警API

ManageEngine Applications Manager提供了列表告警API，该API 允许用户以XML格式列出有关最近告警的信息。告警API列出如下。

  • 列出所有最近的告警
  • 列出所有最近的重要告警
  • 列出所有最近警告的告警
  • 列出所有正常的最近告警
  • 按时间过滤器列出最近的告警
  • 按监视器类型列出告警
  • 按监视器resourceid列出告警
  • 排名前N个告警

该API将列出与API密钥相对应的用户在Applications Manager中配置的监视器的所有告警。此详细信息将包括监视器类型的健康状况和可用性，类型图像，健康状况中断，每种监视器类型的严重/警告/正常/正常/停机计数。

列出告警的API

  • 列出所有告警。

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

  • 列出所有最近的重要告警

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

  • 列出所有最近警告的告警

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

  • 列出所有正常的最近告警

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

  • 在指定时间后列出最近的告警。

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

  • 按监视器名称列出告警

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

  • 按监视器类型列出告警

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

  • 前N个告警

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

  • 按组列出告警

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

  • 列出所有告警（不包括业务组）

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

 

注意:a）为了获得所有告警，我们需要传递'type = all'....它是强制性的。b）对于告警严重级别的组合，例如：我们可以将紧急警告作为类型的值传递，以同时获得严重和警告。

 

请求参数

字段描述        
API Key 通过管理标签中的生成API选项生成 的密钥 。
resourceid "resourceid=[ resourceid of monitor ]" 用于列出特定监视器的告警。
Type type = all 用于列出所有告警。
type = critical 用于列出所有严重告警。
type = warning 用于列出所有警告告警。
type = clear 用于列出所有正常告警。
type = [Monitor type] 用于按监视器类型列出告警，其中<monitor type>是AM_ManagedObject表中的TYPE，例如Linux，Windows XP，MYSQL-DB服务器，Apache服务器，UrlMonitor，Tomcat服务器等。
Top N topN = [N] 用于列出前N个告警。
Time time = [Time] 用于列出在指定时间后生成的告警。
<Time> 以毫秒为单位。


额外属性:

AVAILABILITYSEVERITY 这是监视器可用性的严重程度（1-严重，5-正常）
HEALTHSEVERITY (previously known as SEVERITY) 这是监视器的健康状况严重级别（1严重，4警告和5正常）
TECHNICIAN 此值指定已确认/接收了为此监视器生成的告警的技术人员。
ANNOTATION 此值是为为此监视器生成的告警添加的注释。
DetailsPageURL 此值是指向为其生成告警的监视器的详细信息页面的链接。

 

XML响应API： 

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

 

JSON响应API： 

http://[ APM Host ]:[ APM Port ]/AppManager/json/ListAlarms?apikey=[ API Key ]&type=''critical,clear'

 

用于获取所有最近告警详细信息的XML的示例API。

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

 

输出示例：

告警详细信息

DISPLAYNAME 监视器的显示名称，如Linux-1
RESOURCEID 监视器的resourceid
HEALTHSEVERITY 这是监视器的健康状况严重级别（1严重，4警告和5正常）
MESSAGE 诸如资源已关闭之类的告警消息。由于资源不可用，健康处于危急的。
ATTRIBUTE ID 监视器健康状况的属性ID
MODTIME 告警产生时间（ms）
STATUS 正常/警告/严重-告警状态
TYPE 监视器类型，例如Linux
TYPEDISPLAYNAME 显示类型的名称，例如Linux
AVAILABILITYSEVERITY 这是监视器可用性的严重程度（1-严重，5-正常）
TECHNICIAN 此值指定已确认/接收了为此监视器生成的告警的技术人员。
ANNOTATION 此值是为为此监视器生成的告警添加的注释。
DetailsPageURL 此值是指向为其生成告警的监视器的详细信息页面的链接。

 

<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="Health of DB2 is warning. <br>Root Cause : <br>1. Connection Time 1504 > 1500 ms (threshold).<br>"
ANNOTATION="YES" RESOURCEID="10001307" TYPE="DB2-server" DetailsPageURL="/showresource.do?resourceid=10001307&method=showResourceForResourceID&PRINTER_FRIENDLY=true"
TYPEDISPLAYNAME="DB2" SHORTMESSAGE="Health is Warning" HEALTHSEVERITY="4" />
</response>
</result>
</AppManager-response>

 

用于获取特定时间后生成的所有最近告警详细信息的XML的示例API。

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