ManageEngine® Applications Manager List Monitor API |
||
ManageEngine Applications Manager provides List Monitor API that allows the user to list details of monitor by the following categories.
By monitor Type
By monitor ResourceID
Listing all the added monitors
This API lists all the monitors of a given type that are configured in Applications Manager for the user corresponding to the API Key. This details displayed includes the Health and Availability of the monitor types, image type, Health outages and Critical/Warning/Clear/UP/Down count for each monitor type.
APIs for ListMonitor
1. By monitor Type
http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&type=[ TYPE in AM_ManagedObject table ]
2. By particular monitor name
http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&resourceid=[ Resourceid ]
3. Listing all the added monitors
http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&type=all
4. API For XML Response
http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListMonitor?apikey=[ API Key ]&type=all
5. For JSON Response
http://[ APM Host ]:[ APM Port ]/AppManager/json/ListMonitor?apikey=[ API Key ]&type=''Windows'
Note:
a) For getting both Esx VirtualMachine and HyperV VirtualMachine , we can simply pass VirtualMachine as type
b) For getting all windows types, pass 'Windows' as type value
c) For all network devices (devices added to APM from OPM or OpStor) simply pass 'NWD' as value for type.
Request Parameters
Field | Description |
API Key | The key generated from "Generate API" option in the Admin tab. |
Type | "type=<monitor type>" is used to list all the monitors in a specified monitor type. <monitor type> is TYPE in AM_ManagedObject table like Linux, Windows XP, MYSQL-DB-server, Apache-server, UrlMonitor, Tomcat-server, etc. |
resourceid | The resourceid of the monitor |
type | This value specifies the monitor type, to get all monitor types we need to pass 'all' as the value for the field type. |
Extra Attributes:
IMAGEPATH | This monitor type's image path |
LASTALARMTIME | This is the time at which last alarm has been generated. |
Example API that is used to get XML of monitors by monitor type.
http://app-windows:9090/AppManager/xml/ListMonitor?apikey=[ Api Key ]&type=[ Type ]
Example API that is used to get XML of all monitors.
http://app-windows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8
Example API that is used to get XML of a particular monitors.
http://app-windows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceID=10000047
Example output:
Monitor Details:
DISPLAYNAME | Monitor's Display Name |
RESOURCE ID | Monitor's Resource ID |
TYPE | Monitor type like Windows, Linux |
Health Details | Contains HEALTHMESSAGE that gives the Health Root Cause Message, Health Attribute ID, HEALTHSEVERITY - (5/4/1) - Clear/Warning/Crirical , STATUS - Clear/Warning/Critical |
Availability Details | Contains AVAILABILITYMESSAGE that gives the Availability Root Cause Message, Availability Attribute ID, AVAILABILITYSEVERITY - Up/Down (5/1), STATUS - UP/Down |
Managed | True - the monitor is in Managed state, False - the monitor is in Unmanaged State |
RESOURCENAME | Monitor's Resource Name |
DESCRIPTION | Description of the Resource like Network Resource |
RCAPageURL | URL that links to Root Cause Analysis details |
DetailsPageURL | URL that links to details page of the monitor |
LASTALARMTIME | This is the time at which last alarm has been generated. |
<AppManager-response uri="/AppManager/xml/ListMonitor"> <result> <response response-code="4000"> <Monitor DetailsPageURL="/showresource.do?resourceid=10001267&method=showResourceForResourceID&PRINTER_FRIENDLY=true" HEALTHATTRIBUTEID="1651" RESOURCENAME="app-xp2.csez.zohocorpin.com" Managed="true" HEALTHSEVERITY="5" AVAILABILITYATTRIBUTEID="1650" AVAILABILITYMESSAGE="Resource up. <br>The resource APM-Windows is available." TYPESHORTNAME="Windows" TYPE="Windows XP" DESCRIPTION="Network Resource" AVAILABILITYSEVERITY="5" RESOURCEID="10001267" HEALTHMESSAGE="Health of APM-Windows is clear. <br>Root Cause : <br>1. Data Collection Successful<br>2. APM-Windows is up<br>" DISPLAYNAME="APM-Windows" RCAPageURL="/jsp/RCA.jsp?resourceid=10001267&attributeid=1651" HEALTHSTATUS="clear" IMAGEPATH="/images/icon_monitors_windows.gif" AVAILABILITYSTATUS="up" LASTALARMTIME="1332829401029"/> <Monitor DetailsPageURL="/showresource.do?resourceid=10001306&method=showResourceForResourceID&PRINTER_FRIENDLY=true" HEALTHATTRIBUTEID="1651" RESOURCENAME="app-xp1.csez.zohocorpin.com" Managed="true" HEALTHSEVERITY="5" AVAILABILITYATTRIBUTEID="1650" AVAILABILITYMESSAGE="Resource up. <br>The resource app-xp1 is available." TYPESHORTNAME="Windows" TYPE="Windows XP" DESCRIPTION="Network Resource" AVAILABILITYSEVERITY="5" RESOURCEID="10001306" HEALTHMESSAGE="Health of app-xp1 is clear. <br>Root Cause : <br>1. Data Collection Successful<br>2. app-xp1 is up<br>" DISPLAYNAME="app-xp1" RCAPageURL="/jsp/RCA.jsp?resourceid=10001306&attributeid=1651" HEALTHSTATUS="clear" IMAGEPATH="/images/icon_monitors_windows.gif" AVAILABILITYSTATUS="up" LASTALARMTIME="1333002612246"/> </response> </result> </AppManager-response> |
REST APIs |
List Server |