ManageEngine® SQLDBManager Plus


List Monitor Group Details

<< Prev

Home

Next >>

ListMGDetails API

 

This API will fetch the Monitor Group Details of the given monitor group id which includes all the sub-groups and associated monitors configured of the Monitor group. This will also list the monitor groups associated to the user. This will have information about monitor groups today's availability, monitor health outages among subgroups and associated monitors.

 

API for XML Response:

http://[ SQLDBM Host ]:[ APM Port ]/AppManager/xml/ListMGDetails?apikey=[ API Key ]&groupId=10000048

 

API for JSON Response:

http://[ SQLDBM Host ]:[ APM Port ]/AppManager/json/ListMGDetails?apikey=[ API Key ]&groupName=''Test Group'

 

Request Parameters:

 

Field Description
groupId This parameter is used to get the Monitor Group and its associated monitors based on the monitor group id for the user
groupName This parameter is used to get the Monitor Group and its associated monitors based on the monitor group name for the user

Response Details:

Field Description
NAME \ DISPLAYNAME This is the displayname of this group
DetailsPageURL This is the url for the details page of this group
TODAYUNAVAILPERCENT This the today's unavailability percentage of this group
Action This represents whether action is enabled or not
TODAYAVAILPERCENT This the today's availability percentage of this monitor group
TODAYSCHEDDOWNPERCENT This is the today's scheduled downtime percentage of this monitor group
Type This represents the type
HEALTHSEVERITY This represents the severity of the health for this group
AVAILABILITYSEVERITY This represents the severity of the availability for this group
AVAILABILITYMESSAGE This represents the availability message for this group
RESOURCEID This is the resourceid of this group
HealthRCAURL This is the health RCA url of this group
TODAYUNMANGDPERCENT This is the today's unamanaged percentage of this monitor group
HEALTHMESSAGE This represents the health message for this group
HEALTHSTATUS This is the health status of this group
AVAILABILITYSTATUS This is the availability status of this group
SubMonitorGroup

DetailsPageURL ---------> this is details page of the sub group

TODAYUNAVAILPERCENT ---------> This the today's unavailability percentage of this sub group

AvailabilityRCAURL ---------> this is availability RCA url of the sub group

Action ---------> this is action status of the sub group

NAME \ DISPLAYNAME ---------> this is displayname of the sub group

TODAYAVAILPERCENT ---------> this is today's availability percentage of the sub group

TODAYSCHEDDOWNPERCENT ---------> this is today's scheduled downtime percentage of the sub group

HEALTHSEVERITY ---------> this is health severity of the sub group

TYPE ---------> this represents the type of the group

AVAILABILITYSEVERITY ---------> this is availability severity of the sub group

AVAILABILITYMESSAGE ---------> this is availability message of the sub group

RESOURCEID ---------> this is resourceid of the sub group

HealthRCAURL ---------> this is health RCA url of the sub group

TODAYUNMANGDPERCENT ---------> this is today's unmanage percentage of the sub group

HEALTHMESSAGE ---------> this is health message of the sub group

HEALTHSTATUS ---------> this is health status of the sub group

AVAILABILITYSTATUS ---------> This is the availability status of  sub group

Monitors

DetailsPageURL ---------> this is details page of the monitor

TODAYUNAVAILPERCENT ---------> This the today's unavailability percentage of this monitor

AvailabilityRCAURL ---------> this is availability RCA url of the monitor

Action ---------> this is action status of the monitor

NAME \ DISPLAYNAME ---------> this is displayname of the monitor

TODAYAVAILPERCENT ---------> this is today's availability percentage of the monitor

TODAYSCHEDDOWNPERCENT ---------> this is today's scheduled downtime percentage of the monitor

HEALTHSEVERITY ---------> this is health severity of the monitor

TYPE ---------> this represents the type of the monitor

AVAILABILITYSEVERITY ---------> this is availability severity of the monitor

AVAILABILITYMESSAGE ---------> this is availability message of the monitor

RESOURCEID ---------> this is resourceid of the monitor

HealthRCAURL ---------> this is health RCA url of the monitor

TODAYUNMANGDPERCENT ---------> this is today's unmanage percentage of the monitor

HEALTHMESSAGE ---------> this is health message of the monitorof the monitor

HEALTHSTATUS ---------> this is health status of the monitor

AVAILABILITYSTATUS ---------> This is the availability status of the monitor

<AppManager-response uri="/AppManager/xml/ListMGDetails">
<result>
<response response-code="4000">
<MonitorGroups>
<MonitorGroup DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000011&method=showApplication" TODAYUNAVAILPERCENT="0.0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000011&attributeid=17" Action="enabled" NAME="SQLDBManager Plus" TODAYAVAILPERCENT="100.0" TODAYSCHEDDOWNPERCENT="0.0" Type="Monitor Group" HEALTHSEVERITY="5" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource SQLDBManager Plus is up.
Root Cause :
Resource is Up" RESOURCEID="10000011" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000011&attributeid=18" TODAYUNMANGDPERCENT="0.0" HEALTHMESSAGE="Health of SQLDBManager Plus is clear.
Root Cause :
Health is Clear" MODTIME="1380712859145" DISPLAYNAME="SQLDBManager_Group" HEALTHSTATUS="clear" AVAILABILITYSTATUS="up">
<Monitors DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000169&method=showApplication" TODAYUNAVAILPERCENT="0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000169&attributeid=17" Action="enabled" NAME="APP-WIN7-64-3" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0" HEALTHSEVERITY="5" TYPE="MSSQL-DB-server" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource up.
The resource APP-WIN7-64-3 is available." RESOURCEID="10000169" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000169&attributeid=18" TODAYUNMANGDPERCENT="0" HEALTHMESSAGE="Health of APP-WIN7-64-3 is clear.
Root Cause :
1. app-win7-64-3 --> Data Collection Successful
2. app-win7-64-3 --> No Events Matching the Rule [Any Application error].
3. app-win7-64-3 --> No Events Matching the Rule [Any Security Failure].
4. app-win7-64-3 --> sqlwriter.exe -->
5. SQL Full-text Filter Daemon Launcher (MSSQLSERVER) is up
6. SQL Server (MSSQLSERVER) is up
7. SQL Server Browser is up
8. SQL Server VSS Writer is up
9. APP-WIN7-64-3 is up
10. Buffer Cache Hit Ratio 100 > 90 % (threshold).
11. app-win7-64-3.csez.zohocorpin.com is clear.
12. APP-WIN7-64-3-MergePublDB-MergePubl-APP-WIN7-64-3-2 --> Scheduled Job APP-WIN7-64-3-MergePublDB-MergePubl-APP-WIN7-64-3-2. is clear.
13. APP-WIN7-64-3-MergePublDB-MergePubl-10 --> Scheduled Job APP-WIN7-64-3-MergePublDB-MergePubl-10 is clear.
14. Distribution clean up: distribution --> Scheduled Job Distribution clean up: distribution is clear.
15. Agent history clean up: distribution --> Scheduled Job Agent history clean up: distribution is clear.
16. APP-WIN7-64-3-TPublDB-TPubl-APP-WIN7-64-3-13 --> Scheduled Job APP-WIN7-64-3-TPublDB-TPubl-APP-WIN7-64-3-13. is clear.
17. APP-WIN7-64-3-TPublDB-TPubl2-8 --> Scheduled Job APP-WIN7-64-3-TPublDB-TPubl2-8. is clear.
18. Replication agents checkup --> Scheduled Job Replication agents checkup is clear.
19. syspolicy_purge_history --> Scheduled Job syspolicy_purge_history is clear.
20. skip_test_job --> Scheduled Job skip_test_job is clear.
21. Reinitialize subscriptions having data validation failures --> Scheduled Job Reinitialize subscriptions having data validation failures. is clear.
22. APP-WIN7-64-3-SnapshotReplDB-SnapshotPubl-APP-WIN7-64-3-20 --> Scheduled Job APP-WIN7-64-3-SnapshotReplDB-SnapshotPubl-APP-WIN7-64-3-20. is clear.
23. APP-WIN7-64-3-TPublDB-TPubl-7 --> Scheduled Job APP-WIN7-64-3-TPublDB-TPubl-7 is clear.
24. Replication monitoring refresher for distribution. --> Scheduled Job Replication monitoring refresher for distribution.. is clear.
25. Database Mirroring Monitor Job --> Scheduled Job Database Mirroring Monitor Job is clear.
26. APP-WIN7-64-3-TPublDB-4 --> Scheduled Job APP-WIN7-64-3-TPublDB-4 is clear.
27. APP-WIN7-64-3-SnapshotReplDB-SnapshotPubl-9 --> Scheduled Job APP-WIN7-64-3-SnapshotReplDB-SnapshotPubl-9 is clear.
28. APP-WIN7-64-3-TPublDB-TPubl2-APP-WIN7-64-3-17 --> Scheduled Job APP-WIN7-64-3-TPublDB-TPubl2-APP-WIN7-64-3-17. is clear.
29. Expired subscription clean up --> Scheduled Job Expired subscription clean up is clear.
30. test --> Scheduled Job test. is clear.
31. MESQLDBM_5500_Sep26 is ONLINE
32. AMDB_ADMIN_11200 is ONLINE
33. AMDB_11300_MSSQL is ONLINE
34. AMDB_11300_MANAGED is ONLINE
35. model is ONLINE
36. SnapshotReplDB is ONLINE
37. distribution is ONLINE
38. AMDB_11220_adminfailover is ONLINE
39. master is ONLINE
40. TPublDB is ONLINE
41. SnapshotReplSubsDB is ONLINE
42. MergePublDB is ONLINE
43. tempdb is ONLINE
44. MESQLDBM is ONLINE
45. TSubsDB is ONLINE
46. msdb is ONLINE
47. AMDB_11220_masfailover is ONLINE
48. MergeSubsDB is ONLINE
" MODTIME="1380712819237" DISPLAYNAME="APP-WIN7-64-3" HEALTHSTATUS="clear" IMAGEPATH="/images/icon_monitors_mssql.gif" AVAILABILITYSTATUS="up"/>
<Monitors DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000046&method=showApplication" TODAYUNAVAILPERCENT="0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000046&attributeid=17" Action="enabled" NAME="poorani-1360" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0" HEALTHSEVERITY="5" TYPE="MSSQL-DB-server" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource up.
The resource poorani-1360 is available." RESOURCEID="10000046" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000046&attributeid=18" TODAYUNMANGDPERCENT="0" HEALTHMESSAGE="Health of poorani-1360 is clear.
Root Cause :
1. poorani-1360 --> Data Collection Successful
2. poorani-1360 --> No Events Matching the Rule [Any Application error].
3. poorani-1360 --> No Events Matching the Rule [Any Security Failure].
4. poorani-1360 --> sqlservr.exe -->
5. poorani-1360 --> sqlwriter.exe -->
6. SQL Server (POORANI) is up
7. SQL Server VSS Writer is up
8. poorani-1360 is up
9. Buffer Cache Hit Ratio 99 > 90 % (threshold).
10. poorani-1360.csez.zohocorpin.com is clear.
11. syspolicy_purge_history --> Scheduled Job syspolicy_purge_history. is clear.
12. AMDB_Sep30 is ONLINE
13. model is ONLINE
14. tempdb is ONLINE
15. AMDB is ONLINE
16. master is ONLINE
17. MESQLDBM_POORNI is ONLINE
18. msdb is ONLINE
" MODTIME="1380711174184" DISPLAYNAME="poorani-1360" HEALTHSTATUS="clear" IMAGEPATH="/images/icon_monitors_mssql.gif" AVAILABILITYSTATUS="up"/>
</MonitorGroup>
</MonitorGroups>
</response>
</result>
</AppManager-response>

JSON Input

http://sqldbm-prod1:9433/AppManager/json/ListMGDetails?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all

JSON Response

{"response":{"result":[{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=10000011&method=showApplication","Monitors":[{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=10000169&method=showApplication","TODAYUNAVAILPERCENT":"0","AvailabilityRCAURL":"/jsp/RCA.jsp?resourceid=10000169&attributeid=17","Action":"enabled","NAME":"APP-WIN7-64-3","TODAYAVAILPERCENT":"100","TODAYSCHEDDOWNPERCENT":"0","HEALTHSEVERITY":"5","TYPE":"MSSQL-DB-server","AVAILABILITYSEVERITY":"5","AVAILABILITYMESSAGE":"Resource up. <br>The resource APP-WIN7-64-3 is available.","RESOURCEID":"10000169","HealthRCAURL":"/jsp/RCA.jsp?resourceid=10000169&attributeid=18","TODAYUNMANGDPERCENT":"0","HEALTHMESSAGE":"Health of APP-WIN7-64-3 is clear. <br>Root Cause : <br>1. app-win7-64-3 --> Data Collection Successful<br>2. app-win7-64-3 --> <br>3. app-win7-64-3 --> No Events Matching the Rule [Any Application error].<br>4. app-win7-64-3 --> No Events Matching the Rule [Any Security Failure].<br>5. app-win7-64-3 --> sqlservr.exe --> <br>6. app-win7-64-3 --> sqlbrowser.exe --> <br>7. app-win7-64-3 --> sqlwriter.exe --> <br>8. SQL Full-text Filter Daemon Launcher (MSSQLSERVER) is up<br>9. SQL Server (MSSQLSERVER) is up<br>10. SQL Server Browser is up<br>11. SQL Server VSS Writer is up<br>12. APP-WIN7-64-3 is up<br>13. Buffer Cache Hit Ratio 100 > 90 % (threshold).<br>14. app-win7-64-3.csez.zohocorpin.com is clear.<br>15. APP-WIN7-64-3-MergePublDB-MergePubl-APP-WIN7-64-3-2 --> Scheduled Job APP-WIN7-64-3-MergePublDB-MergePubl-APP-WIN7-64-3-2. is clear. <br>16. APP-WIN7-64-3-MergePublDB-MergePubl-10 --> Scheduled Job APP-WIN7-64-3-MergePublDB-MergePubl-10 is clear.<br>17. Distribution clean up: distribution --> Scheduled Job Distribution clean up: distribution is clear.<br>18. Agent history clean up: distribution --> Scheduled Job Agent history clean up: distribution is clear.<br>19. APP-WIN7-64-3-TPublDB-TPubl-APP-WIN7-64-3-13 --> Scheduled Job APP-WIN7-64-3-TPublDB-TPubl-APP-WIN7-64-3-13. is clear. <br>20. APP-WIN7-64-3-TPublDB-TPubl2-8 --> Scheduled Job APP-WIN7-64-3-TPublDB-TPubl2-8. is clear. <br>21. Replication agents checkup --> Scheduled Job Replication agents checkup is clear.<br>22. syspolicy_purge_history --> Scheduled Job syspolicy_purge_history is clear.<br>23. skip_test_job --> Scheduled Job skip_test_job is clear.<br>24. Reinitialize subscriptions having data validation failures --> Scheduled Job Reinitialize subscriptions having data validation failures. is clear. <br>25. APP-WIN7-64-3-SnapshotReplDB-SnapshotPubl-APP-WIN7-64-3-20 --> Scheduled Job APP-WIN7-64-3-SnapshotReplDB-SnapshotPubl-APP-WIN7-64-3-20. is clear. <br>26. APP-WIN7-64-3-TPublDB-TPubl-7 --> Scheduled Job APP-WIN7-64-3-TPublDB-TPubl-7 is clear.<br>27. Replication monitoring refresher for distribution. --> Scheduled Job Replication monitoring refresher for distribution.. is clear. <br>28. Database Mirroring Monitor Job --> Scheduled Job Database Mirroring Monitor Job is clear.<br>29. APP-WIN7-64-3-TPublDB-4 --> Scheduled Job APP-WIN7-64-3-TPublDB-4 is clear. <br>30. APP-WIN7-64-3-SnapshotReplDB-SnapshotPubl-9 --> Scheduled Job APP-WIN7-64-3-SnapshotReplDB-SnapshotPubl-9 is clear.<br>31. APP-WIN7-64-3-TPublDB-TPubl2-APP-WIN7-64-3-17 --> Scheduled Job APP-WIN7-64-3-TPublDB-TPubl2-APP-WIN7-64-3-17. is clear. <br>32. Expired subscription clean up --> Scheduled Job Expired subscription clean up is clear.<br>33. test --> Scheduled Job test. is clear. <br>34. MESQLDBM_5500_Sep26 is ONLINE <br>35. AMDB_ADMIN_11200 is ONLINE <br>36. AMDB_11300_MSSQL is ONLINE <br>37. AMDB_11300_MANAGED is ONLINE <br>38. model is ONLINE <br>39. SnapshotReplDB is ONLINE <br>40. distribution is ONLINE <br>41. AMDB_11220_adminfailover is ONLINE <br>42. master is ONLINE <br>43. TPublDB is ONLINE <br>44. SnapshotReplSubsDB is ONLINE <br>45. MergePublDB is ONLINE <br>46. tempdb is ONLINE <br>47. MESQLDBM is ONLINE <br>48. TSubsDB is ONLINE <br>49. msdb is ONLINE <br>50. AMDB_11220_masfailover is ONLINE <br>51. MergeSubsDB is ONLINE <br>","MODTIME":"1380712819237","DISPLAYNAME":"APP-WIN7-64-3","HEALTHSTATUS":"clear","IMAGEPATH":"/images/icon_monitors_mssql.gif","AVAILABILITYSTATUS":"up"},{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=10000046&method=showApplication","TODAYUNAVAILPERCENT":"0","AvailabilityRCAURL":"/jsp/RCA.jsp?resourceid=10000046&attributeid=17","Action":"enabled","NAME":"poorani-1360","TODAYAVAILPERCENT":"100","TODAYSCHEDDOWNPERCENT":"0","HEALTHSEVERITY":"5","TYPE":"MSSQL-DB-server","AVAILABILITYSEVERITY":"5","AVAILABILITYMESSAGE":"Resource up. <br>The resource poorani-1360 is available.","RESOURCEID":"10000046","HealthRCAURL":"/jsp/RCA.jsp?resourceid=10000046&attributeid=18","TODAYUNMANGDPERCENT":"0","HEALTHMESSAGE":"Health of poorani-1360 is clear. <br>Root Cause : <br>1. poorani-1360 --> Data Collection Successful<br>2. poorani-1360 --> <br>3. poorani-1360 --> No Events Matching the Rule [Any Application error].<br>4. poorani-1360 --> No Events Matching the Rule [Any Security Failure].<br>5. poorani-1360 --> sqlservr.exe --> <br>6. poorani-1360 --> sqlwriter.exe --> <br>7. SQL Server (POORANI) is up<br>8. SQL Server VSS Writer is up<br>9. poorani-1360 is up<br>10. Buffer Cache Hit Ratio 99 > 90 % (threshold).<br>11. poorani-1360.csez.zohocorpin.com is clear.<br>12. syspolicy_purge_history --> Scheduled Job syspolicy_purge_history. is clear. <br>13. AMDB_Sep30 is ONLINE <br>14. model is ONLINE <br>15. tempdb is ONLINE <br>16. AMDB is ONLINE <br>17. master is ONLINE <br>18. MESQLDBM_POORNI is ONLINE <br>19. msdb is ONLINE <br>","MODTIME":"1380711174184","DISPLAYNAME":"poorani-1360","HEALTHSTATUS":"clear","IMAGEPATH":"/images/icon_monitors_mssql.gif","AVAILABILITYSTATUS":"up"}],"TODAYUNAVAILPERCENT":"0.0","AvailabilityRCAURL":"/jsp/RCA.jsp?resourceid=10000011&attributeid=17","Action":"enabled","NAME":"SQLDBManager Plus","TODAYAVAILPERCENT":"100.0","TODAYSCHEDDOWNPERCENT":"0.0","Type":"Monitor Group","HEALTHSEVERITY":"5","AVAILABILITYSEVERITY":"5","AVAILABILITYMESSAGE":"Resource SQLDBManager Plus is up. <br>Root Cause : <br>Resource is Up","RESOURCEID":"10000011","HealthRCAURL":"/jsp/RCA.jsp?resourceid=10000011&attributeid=18","TODAYUNMANGDPERCENT":"0.0","HEALTHMESSAGE":"Health of SQLDBManager Plus is clear. <br>Root Cause : <br>Health is Clear","MODTIME":"1380712859145","DISPLAYNAME":"SQLDBManager_Group","HEALTHSTATUS":"clear","AVAILABILITYSTATUS":"up"}],"uri":"/AppManager/json/ListMGDetails"},"response-code":"4000"}

 

 

<< Prev

Home

Next >>

List Monitor Groups

List Monitor Types