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.
Syntax
API for XML Response:
https://[HOST]:[PORT]/AppManager/xml/ListMGDetails?apikey=[ API Key ]&groupId=[GROUP ID]
API for JSON Response:
https://[HOST]:[PORT]/AppManager/json/ListMGDetails?apikey=[ API Key ]&groupName=[GROUP NAME]
Supported HTTP methods: GET
Allowed roles: Administrator, Operator, User
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 |
Note: If the groupName or groupId is not specified in the input, then all the Monitor Group details will be pulled up in the response.
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 | Displays the details of the sub-monitor group.- 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 | Displays the details of the monitors in the monitor group.- 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
|
Sample Request
XML Input
https://apm-prod-server:8443/AppManager/xml/ListMGDetails?apikey=aaaaaabbbbbbccccccddddddeeeeee&groupId=10000468
XML Response
<AppManager-response uri="/AppManager/xml/ListMGDetails"> <result> <response response-code="4000"> <MonitorGroups> <MonitorGroup AVAILABILITYMESSAGE="Resource apm-prod1 is up.
Root Cause :
Resource is Up" AVAILABILITYSEVERITY="5" AVAILABILITYSTATUS="up" Action="enabled" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000468&attributeid=17" DISPLAYNAME="apm-prod1_app-support" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000468&method=showApplication" HEALTHMESSAGE="Health of apm-prod1 is critical.
Root Cause :
Health of Citrix Hypervisor (XenServerHost) is critical.
Root Cause :
1. Health of apm-prod2 (XenServerVM) is critical
" HEALTHSEVERITY="1" HEALTHSTATUS="critical" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000468&attributeid=18" MODTIME="1604920717751" NAME="476a9ccd-1649-53f5-3590-71c24ebd3db0" RESOURCEID="10000468" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0.0" TODAYUNAVAILPERCENT="0" TODAYUNMANGDPERCENT="0.0" Type="Monitor Group"> <Monitors AVAILABILITYMESSAGE="Resource up.
The resource Citrix Hypervisor is available." AVAILABILITYSEVERITY="5" AVAILABILITYSTATUS="up" Action="enabled" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000467&attributeid=17" DISPLAYNAME="Citrix Hypervisor_app-support" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000467&method=showApplication" HEALTHMESSAGE="Health of Citrix Hypervisor (XenServerHost) is critical.
Root Cause :
1. Health of apm-prod2 (XenServerVM) is critical
" HEALTHSEVERITY="1" HEALTHSTATUS="critical" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000467&attributeid=18" IMAGEPATH="/images/icon_xenserver.gif" MODTIME="1604920717595" NAME="Citrix Hypervisor_app-support" RESOURCEID="10000467" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0.0" TODAYUNAVAILPERCENT="0" TODAYUNMANGDPERCENT="0.0" TYPE="XenServerHost"/> </MonitorGroup> <MonitorGroup AVAILABILITYMESSAGE="Resource APM Insight is up.
Root Cause :
Resource is Up" AVAILABILITYSEVERITY="5" AVAILABILITYSTATUS="up" Action="enabled" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10025488&attributeid=17" DISPLAYNAME="APM Insight_app-support" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10025488&method=showApplication" HEALTHMESSAGE="Health of APM Insight is clear.
Root Cause :
Health is Clear" HEALTHSEVERITY="5" HEALTHSTATUS="clear" HealthRCAURL="/jsp/RCA.jsp?resourceid=10025488&attributeid=18" MODTIME="1604860673691" NAME="APM Insight" RESOURCEID="10025488" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0.0" TODAYUNAVAILPERCENT="0" TODAYUNMANGDPERCENT="0.0" Type="Monitor Group"> <Monitors AVAILABILITYMESSAGE="Resource up.
The resource apm-prod1:9090 is available." AVAILABILITYSEVERITY="5" AVAILABILITYSTATUS="up" Action="disabled" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000158&attributeid=17" DISPLAYNAME="apm-prod1:9090 - Test_app-support" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000158&method=showApplication" HEALTHMESSAGE="Health of apm-prod1:9090 - Test (APM-Insight-Instance) is clear.
Root Cause :
1. apm-prod1:9090 - Test (APM-Insight-Instance) is up
2. Response Time 40 <= 1500 ms (threshold).
" HEALTHSEVERITY="5" HEALTHSTATUS="clear" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000158&attributeid=18" IMAGEPATH="/apminsight/images/apminsight-icon.gif" MODTIME="1604860673436" NAME="apm-prod1:9090 - Test_app-support" RESOURCEID="10000158" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0.0" TODAYUNAVAILPERCENT="0" TODAYUNMANGDPERCENT="0.0" TYPE="APM-Insight-Instance"/> </MonitorGroup> <MonitorGroup AVAILABILITYMESSAGE="Resource Applications Manager is up.
Root Cause :
Resource is Up" AVAILABILITYSEVERITY="5" AVAILABILITYSTATUS="up" Action="enabled" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10013&attributeid=17" DISPLAYNAME="Applications Manager" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10013&method=showApplication" HEALTHMESSAGE="Health of Applications Manager is critical.
Root Cause :
Health of 172.20.18.187 (Windows 2012) is critical.
Root Cause :
1. Netlogon (Service) is down
Health of AD Monitor (ActiveDirectory) is critical.
Root Cause :
1. Database Disk Free Space 157324 > 5 MB (threshold).
2. Database File Size 60 > 5 MB (threshold).
3. Disk Utilization 73 > 5 % (threshold).
4. Verify References for FRS and Replication Infrastructure (Replication Tests) is down
" HEALTHSEVERITY="1" HEALTHSTATUS="critical" HealthRCAURL="/jsp/RCA.jsp?resourceid=10013&attributeid=18" MODTIME="1604367774309" NAME="Applications Manager" RESOURCEID="10013" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0.0" TODAYUNAVAILPERCENT="0" TODAYUNMANGDPERCENT="0.0" Type="Monitor Group"> <Monitors AVAILABILITYMESSAGE="Resource up.
The resource 172.20.18.187 is available." AVAILABILITYSEVERITY="5" AVAILABILITYSTATUS="up" Action="enabled" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10012403&attributeid=17" DISPLAYNAME="172.20.18.187_app-support" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10012403&method=showApplication" HEALTHMESSAGE="Health of 172.20.18.187 (Windows 2012) is critical.
Root Cause :
1. Netlogon (Service) is down
" HEALTHSEVERITY="1" HEALTHSTATUS="critical" HealthRCAURL="/jsp/RCA.jsp?resourceid=10012403&attributeid=18" IMAGEPATH="/images/icon_monitors_windows.gif" MODTIME="1589283325149" NAME="172.20.18.187_app-support" RESOURCEID="10012403" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0.0" TODAYUNAVAILPERCENT="0" TODAYUNMANGDPERCENT="0.0" TYPE="Windows 2012"/> <Monitors AVAILABILITYMESSAGE="Resource up.
The resource AD Monitor is available." AVAILABILITYSEVERITY="5" AVAILABILITYSTATUS="up" Action="disabled" AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10002427&attributeid=17" DISPLAYNAME="AD Monitor_app-support" DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10002427&method=showApplication" HEALTHMESSAGE="Health of AD Monitor (ActiveDirectory) is critical.
Root Cause :
1. Database Disk Free Space 157324 > 5 MB (threshold).
2. Database File Size 60 > 5 MB (threshold).
3. Disk Utilization 73 > 5 % (threshold).
4. Verify References for FRS and Replication Infrastructure (Replication Tests) is down
" HEALTHSEVERITY="1" HEALTHSTATUS="critical" HealthRCAURL="/jsp/RCA.jsp?resourceid=10002427&attributeid=18" IMAGEPATH="/images/activedirectory.gif" MODTIME="1604920790289" NAME="AD Monitor_app-support" RESOURCEID="10002427" TODAYAVAILPERCENT="100" TODAYSCHEDDOWNPERCENT="0.0" TODAYUNAVAILPERCENT="0" TODAYUNMANGDPERCENT="0.0" TYPE="ActiveDirectory"/> </MonitorGroup> </MonitorGroups> </response> </result> </AppManager-response>
JSON Input
https://apm-prod-server:8443/AppManager/json/ListMGDetails?apikey=aaaaaabbbbbbccccccddddddeeeeee&groupName=AppmanagerHomePage
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":"AppmanagerHomePage","TODAYAVAILPERCENT":"100","TODAYSCHEDDOWNPERCENT":"0","HEALTHSEVERITY":"1","TYPE":"UrlMonitor","AVAILABILITYSEVERITY":"1","AVAILABILITYMESSAGE":"Resource down.
The resource AppmanagerHomePage is not available.Connection Timed Out. Increase the time out level:ResponseCode -200
-->>","RESOURCEID":"20000043","HealthRCAURL":"/jsp/RCA.jsp?resourceid=20000043&attributeid=18","TODAYUNMANGDPERCENT":"0","HEALTHMESSAGE":"Health of AppmanagerHomePage is critical.
Root Cause :
1. AppmanagerHomePage is down
","HEALTHSTATUS":"critical","DISPALYNAME":"AppmanagerHomePage","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.
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.
Root Cause :
1. apm-prod1_Apache Server_9090 is up
2. Response Time 16 ","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.
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.
Root Cause :
1. Data Collection Successful
2. apm-prod1_Windows Vista is up
","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.
Root Cause :
1. Resource down.
The resource AppmanagerHomePage is not available.Connection Timed Out. Increase the time out level:ResponseCode -200
-->>","RESOURCEID":"20000036","HealthRCAURL":"/jsp/RCA.jsp?resourceid=20000036&attributeid=18","TODAYUNMANGDPERCENT":"0.0","HEALTHMESSAGE":"Health of Applications Manager is Critical.
Root Cause :
1. Health of AppmanagerHomePage is critical.
Root Cause :
1. AppmanagerHomePage is down
","DISPLAYNAME":"Applications Manager","HEALTHSTATUS":"critical","AVAILABILITYSTATUS":"down"}]}}
