监视器列表 API


ManageEngine Applications Manager提供了列表监视器API,该API允许用户按以下类别列出监视器的详细信息。

  1. 按监视器类型
  2. 通过监视器ResourceID
  3. 列出所有添加的监视器

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

监视器API

1. 按监视器类型

XML响应API:

http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&type=[ TYPE in AM_ManagedObject table ]

JSON响应的API:

http://[ Host ]:[ Port ]/AppManager/json/ListMonitor?apikey=[ API key ]&type=[ TYPE in AM_ManagedObject table ]

2. 通过监控ResourceID

XML响应API:

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

JSON响应的API:

http://[ Host ]:[ Port ]/AppManager/json/ListMonitor?apikey=[ API key ]&resourceid=[ Resourceid ]

3. 列出所有添加的监视器

XML响应API:

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

JSON响应的API:

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

 
注意:
a)为了同时获得Esx VirtualMachine和HyperV VirtualMachine,我们可以简单地将VirtualMachine作为类型传递
b)要获取所有窗口类型,请将Windows作为类型值传递
c)对于所有网络设备(从OPM添加到APM的设备),只需传递NWD作为类型值。

请求参数

字段 描述        
apikey 通过管理标签中的生成API选项生成的密钥。
type type = <监视器类型>用于列出指定监视器类型中的所有监视器。
<monitor type>是AM_ManagedObject表中的TYPE,例如Linux,Windows XP,MYSQL-DB服务器,Apache服务器,UrlMonitor,Tomcat服务器等。

要获取所有监视器类型,我们需要传递all作为字段类型的值

 

resourceid 监视器的resourceid

示例请求

1. 按监视器类型

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=[Api Key]&type=Windows

2. 通过监控ResourceID

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceid=10000047

3.列出所有添加的监视器

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&type=all

示例响应

输入:

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=831975d6aace66d71c4f63027&resourceid=1000003

响应:

<AppManager-response uri="/AppManager/xml/ListMonitor"><result><response response-code="4000"><Monitor DetailsPageURL="/showresource.do?resourceid=10000035&method=showResourceForResourceID&PRINTER_FRIENDLY=true" HEALTHATTRIBUTEID="1931" ASSOCIATEDGROUPS="Name:Applications Manager;Id:10000029,Name:SubGrp11;Id:10000105" RESOURCENAME="app-windows:9090.csez.zohocorpin.com" Managed="true" HEALTHSEVERITY="1" AVAILABILITYATTRIBUTEID="1930" AVAILABILITYMESSAGE="Resource up. <
>The resource app-windows:9090_Windows 7 is available." AVAILABILITYSEVERITY="5" TYPESHORTNAME="Windows" TYPE="Windows 7" describe="Network Resource" HOSTNAME="app-windows:9090.csez.zohocorpin.com" RESOURCEID="10000035" HEALTHMESSAGE="Health of app-windows:9090_Windows 7 is critical. <br>Root Cause : <br>1. aaa is down <br>2. 111 is down <br>" PORT="-1" DISPLAYNAME="app-windows:9090_Windows 7" RCAPageURL="/jsp/RCA.jsp?resourceid=10000035&attributeid=1931" HEALTHSTATUS="critical" HOSTIP="192.168.26.145" IMAGEPATH="/images/icon_monitors_windows.gif" AVAILABILITYSTATUS="up" LASTALARMTIME="1409221314773"/></response></result></AppManager-response>

注意: 您可以通过执行ListMonitor API请求来获取监视器的resourceid。该请求的输出包含监视器的resourceid以及其他值。

响应参数

响应字段 描述
DISPLAYNAME 监视器的显示名称
RESOURCEID 监视器的resourceid
TYPE 监视器类型,例如Windows,Linux
Health Details 包含
HEALTHMESSAGE- 健康根源邮件
HEALTHATTRIBUTEID - 健康属性ID 
HEALTHSTATUS-监视器的当前健康状况。它可以有值正常或警告或严重
HEALTHSEVERITY-在数字健康状况。数字1表示严重,4表示警告,1表示正常。
Availability Details 包含
AVAILABILITYMESSAGE-这给可用性根源消息
AVAILABILITYATTRIBUTEID- 可用性属性ID
可用性状态-监视器当前的可用状态。它可以包含正常或停机的值
AVAILABILITYSEVERITY-可用性状态(以数字形式)。数字5代表正常,数字1代表停机。
Managed True-监视器处于托管状态,False-监视器处于非托管状态
RESOURCENAME 监视器的资源名称
DESCRIBE 网络资源之类的资源描述
RCAPageURL 链接到根本原因分析详细信息的URL
DetailsPageURL 链接到监视器详细信息页面的URL
LASTALARMTIME 这是最后一次告警生成的时间(以毫秒为单位)。
IMAGEPATH 此监视器类型的图标图像路径
ASSOCIATEDGROUPS 与该监视器关联的业务组