ListMonitorTypes API


This API will list all the monitor types configured in the Applications Manager for the user corresponding to the API Key. The details include the Health and Availability of the monitor types, type image, Health outages, Critical/Warning/Clear/UP/Down count for each and every monitor type.

Syntax

API for XML Response:

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

API for JSON Response:

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

Response Parameters

Field Description
AVAILUNKNOWNCOUNT This is the count of number of monitors for which availability is unknown.
IMAGE This is the image path for the monitor type
CRITICALCOUNT This is the count of number of monitors for which health is critical in a type
SUBGROUP \ RESCATEGORY This represent the category under which it belongs to. (IIS-Server, Mail-Server, etc.,)
DOWNCOUNT This is the count of number of monitors for which availability is down in a type
HEALTHSEVERITY This is the severity of the health (1-critical, 4-warning and 5-clear)
HEALTHMSG This is the health message for this monitor type
RESCATEGORY This represents the group under which this monitor type is grouped. like (servers, Databases, etc.,)
UPCOUNT This is the count of number of monitors for which availability is up in a type
CLEARCOUNT This is the count of number of monitors for which health is clear in a type
OUTAGES This is the health outages w.r.t the total number of monitors in this type
DISPLAYNAME This is the displayname of the monitor type
WARNINGCOUNT This is the count of number of monitors for which health is warning in a type
AVAILMSG This is the availability message for this monitor type
COUNT This is the total number of monitors in this type
HEALTHUNKNOWNCOUNT This is the count of number of monitors for which health is unknown in a type
RESOURCETYPEURL This is the url of the page where all the monitor's of this type will be listed.
AVAILSEVERITY This is the severity of the availability for this type (clear -5, down -1)

Example

XML Input:

http://apm-prod1:9090/AppManager/xml/ListMonitorTypes?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all

XML Response:

<AppManager-response uri="/AppManager/xml/ListMonitorTypes">
<result>
<response response-code="4000">
<MonitorType AVAILUNKNOWNCOUNT="0" IMAGE="/images/icon_monitors_solaris.gif" CRITICALCOUNT="0" SUBGROUP="Sun Solaris" DOWNCOUNT="0" HEALTHSEVERITY="5" HEALTHMSG="Health is clear.<br>Root Cause:<br>1. Health of Sunsolaris is clear <br>" RESCATEGORY="SYS" UPCOUNT="1" CLEARCOUNT="1" OUTAGES="0/1" DISPLAYNAME="Sun Solaris" WARNINGCOUNT="0" AVAILMSG="Resource is up.<br>Root Cause:<br>1. Sunsolaris is up <br> <br>" COUNT="1" HEALTHUNKNOWNCOUNT="0" RESOURCETYPEURL="/showresource.do?method=showResourceTypes&direct=true&network=Sun Solaris&detailspage=true&PRINTER_FRIENDLY=true" AVAILSEVERITY="5"/>
<MonitorType AVAILUNKNOWNCOUNT="0" IMAGE="/images/icon_monitor_vmware.gif" CRITICALCOUNT="7" SUBGROUP="VirtualMachine" DOWNCOUNT="8" HEALTHSEVERITY="1" HEALTHMSG="Health is critical.<br>Root Cause:<br>1. Health of amp-vm-centos64 is critical <br>2. Health of opman-xp32-2-test is critical <br>3. Health of opman-ubuntu10-1-ttt11 is critical <br>4. Health of tes-111-5689-linux-2 is critical <br>5. Health of opman-ubuntu10-6-test2 is critical <br>6. Health of Jim Linux Box is critical <br>7. Health of ICONVM is critical <br>" RESCATEGORY="VIR" UPCOUNT="8" CLEARCOUNT="8" OUTAGES="7/16" DISPLAYNAME="Virtual Machine" WARNINGCOUNT="0" AVAILMSG="Resource is down.<br>Root Cause:<br>1. amp-vm-centos64 is down <br> <br>2. null is down <br> <br>3. opman-xp32-2-test is down <br> <br>4. opman-ubuntu10-1-ttt11 is down <br> <br>5. tes-111-5689-linux-2 is down <br> <br>6. opman-ubuntu10-6-test2 is down <br> <br>7. Jim Linux Box is down <br> <br>8. ICONVM is down <br> <br>" COUNT="16" HEALTHUNKNOWNCOUNT="1" RESOURCETYPEURL="/showresource.do?method=showResourceTypes&direct=true&network=VirtualMachine&detailspage=true&PRINTER_FRIENDLY=true" AVAILSEVERITY="1"/>
<MonitorType AVAILUNKNOWNCOUNT="0" IMAGE="/images/icon_monitor_SSL.gif" CRITICALCOUNT="0" SUBGROUP="SSLCertificateMonitor" DOWNCOUNT="0" HEALTHSEVERITY="5" HEALTHMSG="Health is clear.<br>Root Cause:<br>1. Health of ZOHO is clear <br>" RESCATEGORY="URL" UPCOUNT="1" CLEARCOUNT="1" OUTAGES="0/1" DISPLAYNAME="SSL Certificate Monitor" WARNINGCOUNT="0" AVAILMSG="Resource is up.<br>Root Cause:<br>1. ZOHO is up <br> <br>" COUNT="1" HEALTHUNKNOWNCOUNT="0" RESOURCETYPEURL="/showresource.do?method=showResourceTypes&direct=true&network=SSLCertificateMonitor&detailspage=true&PRINTER_FRIENDLY=true" AVAILSEVERITY="5"/>
</response>
</result>
</AppManager-response>

JSON Input:

http://apm-prod1:9090/AppManager/json/ListMonitorTypes?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all

JSON Response:

{"response-code":"4000","response":{"uri":"/AppManager/json/ListMonitorTypes","result":[{"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitors_urlmonitor.gif","CRITICALCOUNT":"1","SUBGROUP":"UrlMonitor","DOWNCOUNT":"1","HEALTHSEVERITY":"1","HEALTHMSG":"Health is critical.<br>Root Cause:<br>1. Health of AppManager Home Page is critical <br>","RESCATEGORY":"URL","UPCOUNT":"0","CLEARCOUNT":"0","OUTAGES":"1/1","DISPLAYNAME":"HTTP(s) URLs","WARNINGCOUNT":"0","AVAILMSG":"Resource is down.<br>Root Cause:<br>1. AppManager Home Page is down <br>","COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":"/showresource.do?method=showResourceTypes&direct=true&network=UrlMonitor&detailspage=true&PRINTER_FRIENDLY=true","AVAILSEVERITY":"1"},{"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitors_apache.gif","CRITICALCOUNT":"0","SUBGROUP":"Apache-server","DOWNCOUNT":"0","HEALTHSEVERITY":"5","HEALTHMSG":"Health is clear.<br>Root Cause:<br>1. Health of apm-prod1_Apache Server_9090 is clear <br>","RESCATEGORY":"URL","UPCOUNT":"1","CLEARCOUNT":"1","OUTAGES":"0/1","DISPLAYNAME":"Apache Server","WARNINGCOUNT":"0","AVAILMSG":"Resource is up.<br>Root Cause:<br>1. apm-prod1_Apache Server_9090 is up <br>","COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":"/showresource.do?method=showResourceTypes&direct=true&network=Apache-server&detailspage=true&PRINTER_FRIENDLY=true","AVAILSEVERITY":"5"},{"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitors_windows.gif","CRITICALCOUNT":"0","SUBGROUP":"Windows","DOWNCOUNT":"0","HEALTHSEVERITY":"5","HEALTHMSG":"Health is clear.<br>Root Cause:<br>1. Health of apm-prod1_Windows Vista is clear <br>","RESCATEGORY":"SYS","UPCOUNT":"1","CLEARCOUNT":"1","OUTAGES":"0/1","DISPLAYNAME":"Windows","WARNINGCOUNT":"0","AVAILMSG":"Resource is up.<br>Root Cause:<br>1. apm-prod1_Windows Vista is up <br>","COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":"/showresource.do?method=showResourceTypes&direct=true&network=Windows&detailspage=true&PRINTER_FRIENDLY=true","AVAILSEVERITY":"5"}]}}

Note: We hope to support the others in future, depending on popular customer demand.