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:

 

FieldDescription
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:

 

FieldDescription
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

  

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.
The resource AppManager Home Page 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 AppManager Home Page is critical.
Root Cause :
1. AppManager Home Page is down
","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.
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 AppManager Home Page is not available.Connection Timed Out. Increase the time out level:ResponseCode -200
    -->><\/li><\/ol>","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 AppManager Home Page is critical.
      Root Cause :
      1. AppManager Home Page is down
      <\/li><\/ol>","DISPLAYNAME":"Applications Manager","HEALTHSTATUS":"critical","AVAILABILITYSTATUS":"down"}]}}