ManageEngine® SQLDBManager Plus


List Monitor Groups

<< Prev

Home

Next >>

ListMonitorGroups API

 

This API will fetch all the List of Monitor Groups created in the Server 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/ListMonitorGroups?apikey=[ API Key ]&type=all


API for JSON Response:
http://[ SQLDBM Host ]:[ APM Port ]/AppManager/json/ListMonitorGroups?apikey=[ API Key ]&groupId=10000035


Request Parameters:

 

Field Description
type To get all monitor groups we need to pass 'all' as the value for the field type.
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

DetailsPageURL

This is the url for the details page of the monitor group
TODAYUNAVAILPERCENT This value represents the today's unavailability perecentage
AvailabilityRCAURL This represents the Availability RCA Url.
Action This represents status of the monitor group whether actions or enabled or not
CRITICALCOUNT This represents the critical monitors/monitorgroups count
NAME \ DISPLAYNAME This Represents the displayname of the monitor group
DOWNCOUNT This represents the total number of monitors/monitor groups down in this group
TODAYAVAILPERCENT This value represents the today's availability perecentage
TODAYSCHEDDOWNPERCENT This value represents the today's scheduled downtime perecentage
Type This value represents type i.e Monitor group or sub group
HEALTHSEVERITY This represents the severity of the health for this Monitor group (1-critical, 4-warning & 5-clear)
HealthUnknownCount This represents the number of monitors or subgroups for which the health is unknown.
AVAILABILITYSEVERITY This represents the severity of the availability for this monitor group (1-down , 5-up)
AVAILABILITYMESSAGE This is the availability message for this group
RESOURCEID This is the resourceid of the monitor group.
CLEARCOUNT This represents the number of monitors or subgroups for which the health is clear.
UPCOUNT This represents the number of monitors or subgroups for which the availability is up.
HealthRCAURL This represents the link which show the Health RCA of this group.
TODAYUNMANGDPERCENT This value represents the today's unmanaged perecentage
HEALTHMESSAGE This is the health message for this group
AvailabilityUnknownCount This represents the number of monitors or subgroups for which the availability is unknown.
OUTAGES This represents the number of monitors or subgroups for which the health is not clear.
WARNINGCOUNT This represents the number of monitors or subgroups for which the health is warning.
HEALTHSTATUS This represents health status of this group (CRITICAL / CLEAR / WARNING)
AVAILABILITYSTATUS This represents availablility status of this group (UP/ DOWN)
SubMonitorGroup

DetailsPageURL --- This is the details page of the sub group

TODAYUNAVAILPERCENT --- this is today's unavailability percentage for sub group

AvailabilityRCAURL --- this represents the availability RCA url for sub group

Action --- this states whether the actions are enabled for this subgroup or not.

NAME \ DISPALYNAME --- this is the displayname of the subgroup

TODAYAVAILPERCENT --- this is today's availability percentage for sub group

TODAYSCHEDDOWNPERCENT --- this is today's scheduled downtime percentage for sub group

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

TYPE --- this represents whether it is subgroup/group

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

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

RESOURCEID --- this is resource id the sub group

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

TODAYUNMANGDPERCENT --- this is today's unmanaged 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 availability status of the sub group

<AppManager-response uri="/AppManager/xml/ListMonitorGroups">
<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" CRITICALCOUNT="0" NAME="SQLDBManager Plus" DOWNCOUNT="0" TODAYAVAILPERCENT="100.0" TODAYSCHEDDOWNPERCENT="0.0" Type="Monitor Group" HEALTHSEVERITY="5" HealthUnknownCount="0" AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource SQLDBManager Plus is up.
Root Cause :
Resource is Up" RESOURCEID="10000011" CLEARCOUNT="2" UPCOUNT="2" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000011&attributeid=18" TODAYUNMANGDPERCENT="0.0" HEALTHMESSAGE="Health of SQLDBManager Plus is clear.
Root Cause :
Health is Clear" AvailabilityUnknownCount="0" OUTAGES="0/2" DISPLAYNAME="SQLDBManager_Group" WARNINGCOUNT="0" HEALTHSTATUS="clear" AVAILABILITYSTATUS="up"/>
</MonitorGroups>
</response>
</result>
</AppManager-response>

JSON Input

http://sqldbm-prod1:9433/AppManager/json/ListMonitorGroups?apikey=c4e547c2330e2eb92d3e7af2262da9e9&groupId=10000035

JSON Response

{"response":{"result":[{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=10000011&method=showApplication","TODAYUNAVAILPERCENT":"0.0","AvailabilityRCAURL":"/jsp/RCA.jsp?resourceid=10000011&attributeid=17","Action":"enabled","CRITICALCOUNT":"0","NAME":"SQLDBManager Plus","DOWNCOUNT":"0","TODAYAVAILPERCENT":"100.0","TODAYSCHEDDOWNPERCENT":"0.0","Type":"Monitor Group","HEALTHSEVERITY":"5","HealthUnknownCount":"0","AVAILABILITYSEVERITY":"5","AVAILABILITYMESSAGE":"Resource SQLDBManager Plus is up. <br>Root Cause : <br>Resource is Up","RESOURCEID":"10000011","CLEARCOUNT":"2","UPCOUNT":"2","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","AvailabilityUnknownCount":"0","OUTAGES":"0/2","DISPLAYNAME":"SQLDBManager_Group","WARNINGCOUNT":"0","HEALTHSTATUS":"clear","AVAILABILITYSTATUS":"up"}],"uri":"/AppManager/json/ListMonitorGroups"},"response-code":"4000"}

 

 

 

<< Prev

Home

Next >>

List Monitor

List Monitor Group Details