ManageEngine® Applications Manager


列出告警API

<< 上一页

主页

下一页 >>

列出告警API

 

 

ManageEngine Applications Manager提供显示告警的API,帮助用户用XML格式列出近期告警的信息。

 

显示告警的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 ]

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

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

 

 


注意:

a) 要获取所有告警,我们需要将type置为all,这个属性是必需的

b) 对于告警的严重级别,我们可以设置一个组合,如我们可以传递“critical,warning”作为type的值,以列出所有严重和警告级别的告警


请求参数

字段 描述        
apikey 管理页签中的生成的API键值。
resourceid "resourceid=[ 监视器的resourceid]" 用来列出某个监视器的告警。
Type "type=all" 可以列出所有的告警。
"type=critical" 用来列出所有严重的告警。
"type=warning"用来列出所有警告的告警。
"type=clear"用来列出所有正常的告警。
"type=[ Monitor type ]"用来列出某个监视器类型的告警,如Linux、Windows XP、MYSQL-DB-server、Apache-server、UrlMonitor、 Tomcat-server
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'

 

用来获取近期所有告警的示例。

 

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

 

示例输出

 

告警详细信息

 

DISPLAYNAME 监视器的显示名称。如:Linux-1
RESOURCEID 监视器的资源(Resource)ID
HEALTHSEVERITY 正常、告警和严重[ Clear/Warning/Critical - (5/4/1)]
MESSAGE 告警信息。如:“资源停止,健康状况为严重因为资源不可达。”
ATTRIBUTE ID 监视器的健康属性ID
MODTIME 产生告警的时间(ms)
STATUS 正常、告警和严重(Clear/Warning/Critical) - 告警的状态
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

用来获取指定时间之后产生的告警的示例

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

 

 

<< 上一页

主页

下一页 >>

列出动作API

列出仪表板API