|
ManageEngine® Applications Manager 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://[ APM Host ]:[ APM Port ]/AppManager/xml/ListMGDetails?apikey=[ API Key ]&groupId=10000048
API for JSON Response:
http://[ APM 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 a 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=10000035&method=showApplication" TODAYUNAVAILPERCENT="0.0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000035&attributeid=17" Action="enabled" NAME="Applications Manager" TODAYAVAILPERCENT="100.0" TODAYSCHEDDOWNPERCENT="0.0" Type="Monitor Group" HEALTHSEVERITY="1" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource Applications Manager is up. <br>Root Cause : <br>Resource is Up" RESOURCEID="10000035" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000035&attributeid=18" TODAYUNMANGDPERCENT="0.0" HEALTHMESSAGE="Health of Applications Manager is critical. <br>Root Cause : <br><ol><li>Health of pavankumar-0549 is critical. <br>Root Cause : <br>1. Application Layer Gateway Service is down<br>2. Application Identity is down<br>3. Application Information is down<br></li><li>Health of appman sub1 is critical. <br>Root Cause : <br><ol><li>Health of pavankumar-0549 is critical. <br>Root Cause : <br>1. Application Layer Gateway Service is down<br>2. Application Identity is down<br>3. Application Information is down<br></li></ol></li><li>Health of pavankumar-0549_Tomcat Server_9090 is critical. <br>Root Cause : <br>1. Average Response Time 2694 > 2000 ms (threshold).<br></li></ol>" DISPLAYNAME="Applications Manager" HEALTHSTATUS="critical" AVAILABILITYSTATUS="up"> <Monitors DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000042&method=showApplication" TODAYUNAVAILPERCENT="0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000042&attributeid=17" Action="enabled" NAME="127.0.0.1_MS SQL_pavansqlexpress" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0" HEALTHSEVERITY="5" TYPE="MSSQL-DB-server" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource up. <br>The resource 127.0.0.1_MS SQL_pavansqlexpress is available." RESOURCEID="10000042" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000042&attributeid=18" TODAYUNMANGDPERCENT="0" HEALTHMESSAGE="Health of 127.0.0.1_MS SQL_pavansqlexpress is clear. <br>Root Cause : <br>1. 127.0.0.1_MS SQL_pavansqlexpress is up<br>2. Buffer Hit Ratio 100 > 90 % (threshold).<br>3. is clear.<br>4. master is ONLINE <br>5. model is ONLINE <br>6. msdb is ONLINE <br>7. tempdb is ONLINE <br>8. AMDB_10100 is ONLINE <br>9. AMDB_10030 is ONLINE <br>10. AMDB_test is ONLINE <br>11. syspolicy_purge_history --> Scheduled Job syspolicy_purge_history. is clear. <br>12. AMDB_app_xp4_admin is ONLINE <br>13. AMDB_app_xp4_admin1 is ONLINE <br>14. AMDB_pavan_admin is ONLINE <br>15. AMDB_pavan_MANAGED is ONLINE <br>16. AMDB_imac is ONLINE <br>17. AMDB_ADMIN is ONLINE <br>18. AMD_10100 is ONLINE <br>19. AMDB_sahad is ONLINE <br>" HEALTHSTATUS="clear" DISPALYNAME="127.0.0.1_MS SQL_pavansqlexpress" AVAILABILITYSTATUS="up"/> <Monitors DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000045&method=showApplication" TODAYUNAVAILPERCENT="0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000045&attributeid=17" Action="enabled" NAME="AppManager Home Page" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0" HEALTHSEVERITY="5" TYPE="UrlMonitor" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource up. <br>The resource AppManager Home Page is available.ResponseCode - 200" RESOURCEID="10000045" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000045&attributeid=18" TODAYUNMANGDPERCENT="0" HEALTHMESSAGE="Health of AppManager Home Page is clear. <br>Root Cause : <br>1. AppManager Home Page is up<br>2. Response Time 33 <= 1500 ms (threshold).<br>" HEALTHSTATUS="clear" DISPALYNAME="AppManager Home Page" AVAILABILITYSTATUS="up"/> <Monitors DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000038&method=showApplication" TODAYUNAVAILPERCENT="0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000038&attributeid=17" Action="enabled" NAME="pavankumar-0549" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0" HEALTHSEVERITY="1" TYPE="Windows 7" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource up. <br>The resource pavankumar-0549 is available." RESOURCEID="10000038" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000038&attributeid=18" TODAYUNMANGDPERCENT="0" HEALTHMESSAGE="Health of pavankumar-0549 is critical. <br>Root Cause : <br>1. Application Layer Gateway Service is down<br>2. Application Identity is down<br>3. Application Information is down<br>" HEALTHSTATUS="critical" DISPALYNAME="pavankumar-0549" AVAILABILITYSTATUS="up"/> <Monitors DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000044&method=showApplication" TODAYUNAVAILPERCENT="0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000044&attributeid=17" Action="enabled" NAME="pavankumar-0549-9090" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0" HEALTHSEVERITY="5" TYPE="Port-Test" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource up. <br>The resource pavankumar-0549-9090 is available." RESOURCEID="10000044" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000044&attributeid=18" TODAYUNMANGDPERCENT="0" HEALTHMESSAGE="Health of pavankumar-0549-9090 is clear. <br>Root Cause : <br>1. Response Time 24 <= 1500 ms (threshold).<br>2. pavankumar-0549-9090 is up<br>" HEALTHSTATUS="clear" DISPALYNAME="pavankumar-0549-9090" AVAILABILITYSTATUS="up"/> <Monitors DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000043&method=showApplication" TODAYUNAVAILPERCENT="0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000043&attributeid=17" Action="enabled" NAME="pavankumar-0549_Apache Server_9090" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0" HEALTHSEVERITY="5" TYPE="Apache-server" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource up. <br>The resource pavankumar-0549_Apache Server_9090 is available." RESOURCEID="10000043" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000043&attributeid=18" TODAYUNMANGDPERCENT="0" HEALTHMESSAGE="Health of pavankumar-0549_Apache Server_9090 is clear. <br>Root Cause : <br>1. pavankumar-0549_Apache Server_9090 is up<br>2. Response Time 6 <= 1500 ms (threshold).<br>" HEALTHSTATUS="clear" DISPALYNAME="pavankumar-0549_Apache Server_9090" AVAILABILITYSTATUS="up"/> <Monitors DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000055&method=showApplication" TODAYUNAVAILPERCENT="0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000055&attributeid=17" Action="enabled" NAME="pavankumar-0549_Tomcat Server_9090" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0" HEALTHSEVERITY="1" TYPE="Tomcat-server" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource up. <br>The resource pavankumar-0549_Tomcat Server_9090 is available." RESOURCEID="10000055" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000055&attributeid=18" TODAYUNMANGDPERCENT="0" HEALTHMESSAGE="Health of pavankumar-0549_Tomcat Server_9090 is critical. <br>Root Cause : <br>1. Average Response Time 2694 > 2000 ms (threshold).<br>" HEALTHSTATUS="critical" DISPALYNAME="pavankumar-0549_Tomcat Server_9090" AVAILABILITYSTATUS="up"/> <SubMonitorGroup DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000267&method=showApplication" TODAYUNAVAILPERCENT="0.0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000267&attributeid=17" Action="enabled" NAME="appman sub1" TODAYAVAILPERCENT="100.0" TODAYSCHEDDOWNPERCENT="0.0" HEALTHSEVERITY="1" TYPE="Sub Group" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource appman sub1 is up. <br>Root Cause : <br>Resource is Up" RESOURCEID="10000267" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000267&attributeid=18" TODAYUNMANGDPERCENT="0.0" HEALTHMESSAGE="Health of appman sub1 is critical. <br>Root Cause : <br><ol><li>Health of pavankumar-0549 is critical. <br>Root Cause : <br>1. Application Layer Gateway Service is down<br>2. Application Identity is down<br>3. Application Information is down<br></li></ol>" HEALTHSTATUS="critical" DISPALYNAME="appman sub1" AVAILABILITYSTATUS="up"/> <SubMonitorGroup DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10001149&method=showApplication" TODAYUNAVAILPERCENT="0.0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10001149&attributeid=17" Action="enabled" NAME="Opman" TODAYAVAILPERCENT="100.0" TODAYSCHEDDOWNPERCENT="0.0" HEALTHSEVERITY="-" TYPE="Sub Group" AVAILABILITYSEVERITY="-" AVAILABILITYMESSAGE="-" RESOURCEID="10001149" HealthRCAURL="/jsp/RCA.jsp?resourceid=10001149&attributeid=18" TODAYUNMANGDPERCENT="0.0" HEALTHMESSAGE="-" HEALTHSTATUS="UnKnown" DISPALYNAME="Opman" AVAILABILITYSTATUS="UnKnown"> <SubMonitorGroup DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10001151&method=showApplication" TODAYUNAVAILPERCENT="0" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10001151&attributeid=17" Action="enabled" NAME="123" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0" HEALTHSEVERITY="-" TYPE="Sub Group" AVAILABILITYSEVERITY="-" AVAILABILITYMESSAGE="-" RESOURCEID="10001151" HealthRCAURL="/jsp/RCA.jsp?resourceid=10001151&attributeid=18" TODAYUNMANGDPERCENT="0" HEALTHMESSAGE="-" HEALTHSTATUS="UnKnown" DISPALYNAME="123" AVAILABILITYSTATUS="UnKnown"/> </MonitorGroup> </MonitorGroups> </response> </result> </AppManager-response> |
JSON Input http://apm-prod1:9090/AppManager/json/ListMGDetails?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all JSON Response {"response-code":"4000","response":{"uri":"/AppManager/json/ListMGDetails","result":[{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=20000036&method=showApplication","Monitors":[{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=20000043&method=showApplication","TODAYUNAVAILPERCENT":"0","AvailabilityRCAURL":"/jsp/RCA.jsp?resourceid=20000043&attributeid=17","Action":"enabled","NAME":"AppManager Home Page","TODAYAVAILPERCENT":"100","TODAYSCHEDDOWNPERCENT":"0","HEALTHSEVERITY":"1","TYPE":"UrlMonitor","AVAILABILITYSEVERITY":"1","AVAILABILITYMESSAGE":"Resource down. <br>The resource AppManager Home Page is not available.Connection Timed Out. Increase the time out level:ResponseCode -200<br>-->>","RESOURCEID":"20000043","HealthRCAURL":"/jsp/RCA.jsp?resourceid=20000043&attributeid=18","TODAYUNMANGDPERCENT":"0","HEALTHMESSAGE":"Health of AppManager Home Page is critical. <br>Root Cause : <br>1. AppManager Home Page is down<br>","HEALTHSTATUS":"critical","DISPALYNAME":"AppManager Home Page","AVAILABILITYSTATUS":"down"},{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=20000041&method=showApplication","TODAYUNAVAILPERCENT":"0","AvailabilityRCAURL":"/jsp/RCA.jsp?resourceid=20000041&attributeid=17","Action":"enabled","NAME":"apm-prod1_Apache Server_9090","TODAYAVAILPERCENT":"100","TODAYSCHEDDOWNPERCENT":"0","HEALTHSEVERITY":"5","TYPE":"Apache-server","AVAILABILITYSEVERITY":"5","AVAILABILITYMESSAGE":"Resource up. <br>The resource apm-prod1_Apache Server_9090 is available.","RESOURCEID":"20000041","HealthRCAURL":"/jsp/RCA.jsp?resourceid=20000041&attributeid=18","TODAYUNMANGDPERCENT":"0","HEALTHMESSAGE":"Health of apm-prod1_Apache Server_9090 is clear. <br>Root Cause : <br>1. apm-prod1_Apache Server_9090 is up<br>2. Response Time 16 <= 1500 ms (threshold).<br>","HEALTHSTATUS":"clear","DISPALYNAME":"apm-prod1_Apache Server_9090","AVAILABILITYSTATUS":"up"},{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=20000039&method=showApplication","TODAYUNAVAILPERCENT":"0","AvailabilityRCAURL":"/jsp/RCA.jsp?resourceid=20000039&attributeid=17","Action":"enabled","NAME":"apm-prod1_Windows Vista","TODAYAVAILPERCENT":"100","TODAYSCHEDDOWNPERCENT":"0","HEALTHSEVERITY":"5","TYPE":"Windows Vista","AVAILABILITYSEVERITY":"5","AVAILABILITYMESSAGE":"Resource up. <br>The resource apm-prod1_Windows Vista is available.","RESOURCEID":"20000039","HealthRCAURL":"/jsp/RCA.jsp?resourceid=20000039&attributeid=18","TODAYUNMANGDPERCENT":"0","HEALTHMESSAGE":"Health of apm-prod1_Windows Vista is clear. <br>Root Cause : <br>1. Data Collection Successful<br>2. apm-prod1_Windows Vista is up<br>","HEALTHSTATUS":"clear","DISPALYNAME":"apm-prod1_Windows Vista","AVAILABILITYSTATUS":"up"}],"TODAYUNAVAILPERCENT":"100.0","AvailabilityRCAURL":"/jsp/RCA.jsp?resourceid=20000036&attributeid=17","Action":"enabled","NAME":"Applications Manager","TODAYAVAILPERCENT":"0.0","TODAYSCHEDDOWNPERCENT":"0.0","Type":"Monitor Group","HEALTHSEVERITY":"1","AVAILABILITYSEVERITY":"1","AVAILABILITYMESSAGE":"Resource Applications Manager is down. <br>Root Cause : <br><ol><li>Resource down. <br>The resource AppManager Home Page is not available.Connection Timed Out. Increase the time out level:ResponseCode -200<br>-->><\/li><\/ol>","RESOURCEID":"20000036","HealthRCAURL":"/jsp/RCA.jsp?resourceid=20000036&attributeid=18","TODAYUNMANGDPERCENT":"0.0","HEALTHMESSAGE":"Health of Applications Manager is Critical. <br>Root Cause : <br><ol><li>Health of AppManager Home Page is critical. <br>Root Cause : <br>1. AppManager Home Page is down<br><\/li><\/ol>","DISPLAYNAME":"Applications Manager","HEALTHSTATUS":"critical","AVAILABILITYSTATUS":"down"}]}}
|
ListMonitorGroups API |
ListMonitorTypes API |