ManageEngine® SQLDBManager Plus List Monitor Types | ||
This API will list all the monitor types configured in the SQLDBManagerPlus 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.
API for XML Response:
http://[ SQLDBM Host ]:[ APM Port ]/AppManager/xml/ListMonitorTypes?apikey=[ API Key ]&type=all
API for JSON Response:
http://[ SQLDBM Host ]:[ APM Port ]/AppManager/json/ListMonitorTypes?apikey=[ API Key ]&type=all
NOTE:
We hope to support the others in future, depending on popular customer demand.
Response Details:
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) |
<AppManager-response uri="/AppManager/json/ListMonitorTypes"> <result> <response response-code="4000"> <MonitorType AVAILUNKNOWNCOUNT="0" IMAGE="/images/icon_monitors_windows.gif" CRITICALCOUNT="0" SUBGROUP="Windows" DOWNCOUNT="0" HEALTHSEVERITY="5" HEALTHMSG="Health is clear. Root Cause: 1. Health of poorani-1360 is clear " RESCATEGORY="SYS" UPCOUNT="1" CLEARCOUNT="1" OUTAGES="0/1" DISPLAYNAME="Windows" WARNINGCOUNT="0" AVAILMSG="Resource is up. Root Cause: 1. poorani-1360 is up " COUNT="1" HEALTHUNKNOWNCOUNT="0" RESOURCETYPEURL="/showresource.do?method=showResourceTypes&direct=true&network=Windows&detailspage=true&PRINTER_FRIENDLY=true" AVAILSEVERITY="5"/> <MonitorType AVAILUNKNOWNCOUNT="0" IMAGE="/images/icon_monitor_WMI.gif" CRITICALCOUNT="0" SUBGROUP="Generic WMI" DOWNCOUNT="0" HEALTHSEVERITY="7" HEALTHMSG="Health is Unknown. " RESCATEGORY="CAM" UPCOUNT="1" CLEARCOUNT="0" OUTAGES="0/1" DISPLAYNAME="Windows Performance Counters" WARNINGCOUNT="0" AVAILMSG="Resource is up. Root Cause: 1. 172.18.86.194 is up " COUNT="1" HEALTHUNKNOWNCOUNT="1" RESOURCETYPEURL="/showresource.do?method=showResourceTypes&direct=true&network=Generic WMI&detailspage=true&PRINTER_FRIENDLY=true" AVAILSEVERITY="5"/> <MonitorType AVAILUNKNOWNCOUNT="0" IMAGE="/images/icon_monitors_mssql.gif" CRITICALCOUNT="0" SUBGROUP="MSSQL-DB-server" DOWNCOUNT="0" HEALTHSEVERITY="5" HEALTHMSG="Health is clear. Root Cause: 1. Health of poorani-1360 is clear " RESCATEGORY="DBS" UPCOUNT="1" CLEARCOUNT="1" OUTAGES="0/1" DISPLAYNAME="MSSQLDB" WARNINGCOUNT="0" AVAILMSG="Resource is up. Root Cause: 1. poorani-1360 is up " COUNT="1" HEALTHUNKNOWNCOUNT="0" RESOURCETYPEURL="/showresource.do?method=showResourceTypes&direct=true&network=MSSQL-DB-server&detailspage=true&PRINTER_FRIENDLY=true" AVAILSEVERITY="5"/> </response> </result> </AppManager-response> |
JSON Input http://sqldbm-prod1:9433/AppManager/json/ListMonitorTypes?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all JSON Response {"response":{"result":[{"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitors_mssql.gif","CRITICALCOUNT":"0","SUBGROUP":"MSSQL-DB-server","DOWNCOUNT":"0","HEALTHSEVERITY":"5","HEALTHMSG":"Health is clear.<br>Root Cause:<br>1. Health of poorani-1360 is clear <br>","RESCATEGORY":"DBS","UPCOUNT":"1","CLEARCOUNT":"1","OUTAGES":"0/1","DISPLAYNAME":"MSSQLDB","WARNINGCOUNT":"0","AVAILMSG":"Resource is up.<br>Root Cause:<br>1. poorani-1360 is up <br>","COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":"/showresource.do?method=showResourceTypes&direct=true&network=MSSQL-DB-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 poorani-1360 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. poorani-1360 is up <br>","COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":"/showresource.do?method=showResourceTypes&direct=true&network=Windows&detailspage=true&PRINTER_FRIENDLY=true","AVAILSEVERITY":"5"},{"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitor_WMI.gif","CRITICALCOUNT":"0","SUBGROUP":"Generic WMI","DOWNCOUNT":"0","HEALTHSEVERITY":"7","HEALTHMSG":"Health is Unknown.<br>","RESCATEGORY":"CAM","UPCOUNT":"1","CLEARCOUNT":"0","OUTAGES":"0/1","DISPLAYNAME":"Windows Performance Counters","WARNINGCOUNT":"0","AVAILMSG":"Resource is up.<br>Root Cause:<br>1. 172.18.86.194 is up <br>","COUNT":"1","HEALTHUNKNOWNCOUNT":"1","RESOURCETYPEURL":"/showresource.do?method=showResourceTypes&direct=true&network=Generic WMI&detailspage=true&PRINTER_FRIENDLY=true","AVAILSEVERITY":"5"}],"uri":"/AppManager/json/ListMonitorTypes"},"response-code":"4000"} |
List Monitor Group Details |
List Server |