List Data. ManageEngine Applications Manager

PDF

Dokument

Oglas

ManageEngine Applications Manager : Help Documentation

List Data

The List Data APIs allow you to list monitors, actions, alarms and other relevant data in Applications

Manager: You can even search throught monitors and monitor groups or fetch polled data. The List data

APIs are as follows:

• Get Monitor Data

• List Actions

• List Alarms

• List Dashboards

• List Monitor

• List Monitor Groups

• List Monitor Group Details

• List Monitor Types

• List Server

• List User Details

• Search

• Show Polled Data

If the API is not executed correctly, the request will fail and errors will be thrown. Refer this page for a list of common error conditions.

Zoho Corporation Pvt. Ltd.

578

ManageEngine Applications Manager : Help Documentation

GetMonitorData API

This API allows the user to fetch the data for the latest poll from monitors. At the moment, we support fetching of first-level attributes of a monitor, i.e. the current data for the important attributes of a monitor such as response time, collection time, etc.

Sample Request: http://[Host]:[Port]/AppManager/xml/GetMonitorData?apikey=[APIKEY]&resourceid=[RESOURCEID]

Request Parameters

The parameters involved in the API request are described below:

Field Description

The key generated from "Generate API Key" option in the Admin tab. API Key resourceid The resource id of the monitor for which data needs to be fetched

Example: http://appwindows:9090/AppManager/xml/GetMonitorData?apikey=095cb3835ff015b01a3b3a6c4ab2c38a&resourc

eid=10000293

The above example fetches the current data of a Sybase monitor.

Output for the above example:

<AppManager-response uri="/AppManager/xml/GetMonitorData">

<Monitorinfo

DetailsPageURL="/showresource.do?resourceid=10001267&method=showResourceForResourceID&

PRINTER_FRIENDLY=true"

TODAYUNAVAILPERCENT="0.0" HEALTHATTRIBUTEID="1651" TARGETADDRESS=""

Zoho Corporation Pvt. Ltd.

579

ManageEngine Applications Manager : Help Documentation

RESOURCENAME="app-xp2.csez.zohocorpin.com" TODAYAVAILPERCENT="100.0"

TARGETNAME="" TODAYSCHEDDOWNPERCENT="0.0" AVAILABILITYATTRIBUTEID="1650"

HEALTHSEVERITY="5" DISKUTIL="-1" MANAGED="true" PHYMEMUTIL="-1"

AVAILABILITYMESSAGE="Resource up. The resource APM-Windows is available."

AVAILABILITYSEVERITY="5" TYPESHORTNAME="Windows" TYPE="Windows XP"

DESCRIPTION="Network Resource" LASTPOLLEDTIME="Mar 29, 2012 2:40 PM"

RESOURCEID="10001267" TODAYUNMANGDPERCENT="0.0"

HEALTHMESSAGE="Health of APM-Windows is clear. Root Cause : 1. Data Collection

Successful 2. APM-Windows is up "

CPUUTIL="-1" DISPLAYNAME="APM-Windows" HEALTHSTATUS="clear"

RCAPageURL="/jsp/RCA.jsp?resourceid=10001267&attributeid=1651"

IMAGEPATH="/images/icon_monitors_windows.gif" AVAILABILITYSTATUS="up">

<Attribute DISPLAYNAME="Swap Memory Utilization" Value="No Data Available." Units=" %"

AttributeID="1653" />

<Attribute DISPLAYNAME="Free Physical Memory (MB)" Value="No Data Available." Units=" "

AttributeID="1659" />

<CHILDMONITORINFO DISPLAYNAME="C:" RESOURCEID="10001270" AVAILABILITYSEVERITY="-"

HEALTHSEVERITY="-">

<CHILDATTRIBUTES DISPLAYNAME="Free Disk Space(MB)" Value="63902" Units=" "

AttributeID="737" />

</CHILDMONITORINFO>

<CHILDMONITORINFO DISPLAYNAME="D:" RESOURCEID="10001271" AVAILABILITYSEVERITY="-"

HEALTHSEVERITY="-">

Zoho Corporation Pvt. Ltd.

580

ManageEngine Applications Manager : Help Documentation

<CHILDATTRIBUTES DISPLAYNAME="Free Disk Space(MB)" Value="151427" Units=" "

AttributeID="737" />

</CHILDMONITORINFO>

</CHILDMONITORS>

<CHILDMONITORINFO DISPLAYNAME="MS TCP Loopback interface" RESOURCEID="10001268"

AVAILABILITYSEVERITY="-" HEALTHSEVERITY="-">

</CHILDMONITORINFO>

<CHILDMONITORINFO DISPLAYNAME="Realtek RTL8139 Family PCI Fast Ethernet NIC - Packet

Scheduler Miniport" RESOURCEID="10001269" AVAILABILITYSEVERITY="-" HEALTHSEVERITY="-">

<CHILDATTRIBUTES DISPLAYNAME="Output Traffic" Value="27866" Units=" Kbps" AttributeID="733"

</CHILDMONITORINFO>

</CHILDMONITORS>

</Monitorinfo>

</response>

</result>

</AppManager-response>

Zoho Corporation Pvt. Ltd.

581

ManageEngine Applications Manager : Help Documentation

ListActions API

This API lists all the actions configured for the monitors associated to the users. The details of each action is grouped according to the action type.

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListActions?apikey=[ API Key ]&type=all

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/ListActions?apikey=[ API Key ]&type='all'

In future versions the following features will be included:

i) Listing Actions will be supported in Admin server.

ii) Listing Actions based on the type.

Request Parameters:

Field Description type This value specifies the type of action to be listed, to get all types of actions, we need to pass 'all' as the value for the field type.(In absence of this parameter also it will return all the types)

Response Details:

Field Description

DisplayName This is the displayname of the action.

Action ID - Represents the Action ID

ExecuteActionPath - Represents the uri for executing the action

NAME - Represents the Name of the Action

ActionProps - Represents the Action Proepeties like From Address, To Address,

Message etc., this changes for each and every action type

Zoho Corporation Pvt. Ltd.

582

ManageEngine Applications Manager : Help Documentation

<AppManager-response uri="/AppManager/xml/ListActions">

<Action ID="10000003"

ExecuteActionPath="/common/executeSMS.do?method=testAction&remote=true&actionID=10000003"NAME="SMS">

<ActionProps MESSAGE="This information has been generated by the Applications Manager"

FROMADDRESS="[email protected]" TOADDRESS="[email protected]" />

</Action>

</Actions>

</response>

</result>

</AppManager-response>

JSON Input http://apm-prod1:9090/AppManager/json/ListActions?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type='all'

JSON Response

{"responsecode":"4000","response":{"uri":"/AppManager/json/ListActions","result":[{"Action":[{"ID":"20000003","ExecuteActionPath":"/c from the Applications Manager"}}],"DisplayName":"E-mail Action(s)"}]}}

Zoho Corporation Pvt. Ltd.

583

ManageEngine Applications Manager : Help Documentation

List Alarms API

ManageEngine Applications Manager provides List Alarms API that allows the user to list the information regarding recent alarms in an XML format. The alarm APIs are listed as follows.

• Listing all recent alarms

• Listing all critical recent alarms

• Listing all warning recent alarms

• Listing all clear recent alarms

• Listing recent alarms by time filter

• Listing alarms by monitor type

• Listing alarms by monitor resourceid

• Listing alarms by top N

This API will list all alarms of the monitors configured in the Applications Manager for the user corresponding to the API Key. This details will include the Health and Availability of the monitor types, type image, Health outages, Critical/Warning/Clear/UP/Down count for each and every monitor type.

APIs for ListAlarms.

• Listing all the alarms.

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=all

• Listing all critical recent alarms

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=critical

• Listing all warning recent alarms

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=warning

• Listing all clear recent alarms

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=clear

• Listing recent alarms after specified time.

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&time=[ Time ]

• Listing alarms by monitor name

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&resourceid=[ resourceid ]

• Listing alarms by monitor type

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&type=[ TYPE ]

• Listing alarms by top N

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey=[ API key ]&topN=[ XYZ ]

• Listing alarms by group

http://[ Host ]:[ Port ]/AppManager/xml/ListAlarms?apikey= [ API key ]&groupName=Applications Manager

Zoho Corporation Pvt. Ltd.

584

ManageEngine Applications Manager : Help Documentation

Note:

a) For getting all the alarms we need to pass 'type=all' .... its mandatory. b) For combination of severity of alarms, ex: we can pass 'critical,warning' as a value for type to get both

critcal and warning.

Request Parameters

Field Description

API Key resourceid

The key generated from "Generate API" option in the Admin tab.

"resourceid=[ resourceid of monitor ]" is used to list the alarms of particular monitor.

Type

Time

"type=all" is used to list all alarms.

"type=critical" is used to list all the critical alarms.

"type=warning" is used to list all the warning alarms.

"type=clear" is used to list all the clear alarms.

"type=[ Monitor type ]" is used to list alarms by monitor type where

<monitor type> is TYPE in AM_ManagedObject table like Linux,

Windows XP, MYSQL-DB-server, Apache-server, UrlMonitor, Tomcatserver, etc.

"topN=[ N ]" is used to list the top N alarms.

"time=[ Time ]" is used to list the alarms generated after the specified time.

<Time> is repesented in milli second.

Extra Attributes:

AVAILABILITYSEVERITY This is the monitor availability severity (1 - critical, 5- clear)

HEALTHSEVERITY (previously known

as SEVERITY)

This is the monitor severity for health (1-critical, 4-warning &

5- clear)

Zoho Corporation Pvt. Ltd.

585

TECHNICIAN

ANNOTATION

DetailsPageURL

ManageEngine Applications Manager : Help Documentation

This value specifies the technician who has acknowleged/ picked up the Alarm generated for this monitor.

This value is the annotation added regarding the alarm generated for this monitor.

This value is the link to the details page of the monitor for which the alarm is generated.

API for XML Response : http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListAlarms?apikey=[ API Key ]&type=all

API for JSON Response : http://[ APM Host ]:[ APM Port ]/AppManager/json/ListAlarms?apikey=[ API Key ]&type=''critical,clear'

Example API that is used to get XML of all recent alarms details.

http://app-windows:9090/AppManager/xml/ListAlarms?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a

Example output:

Alarm Details

DISPLAYNAME Display Name of the Monitor like Linux-1

RESOURCEID

HEALTHSEVERITY

Resource ID of the Monitor

This is the monitor severity for health (1-critical, 4-warning & 5- clear)

MESSAGE

ATTRIBUTE ID

MODTIME

Alarm message like 'Resource is down. Health is critical as the resource is not available'

Attribute ID of health of monitor

Time when the Alarm was generated (ms)

Zoho Corporation Pvt. Ltd.

586

ManageEngine Applications Manager : Help Documentation

Clear/Warning/Critical - status of the alarm STATUS

TYPE Type of the Monitor like Linux

Display Name of the Type like 'Linux' TYPEDISPLAYNAME

AVAILABILITYSEVERITY This is the monitor availability severity (1 - critical, 5- clear)

TECHNICIAN

ANNOTATION

DetailsPageURL

This value specifies the technician who has acknowleged/ picked up the

Alarm generated for this monitor.

This value is the annotation added regarding the alarm generated for this monitor.

This value is the link to the details page of the monitor for which the alarm is generated.

<AppManager-response uri="/AppManager/xml/ListAlarms">

<Alarm DISPLAYNAME="DB2" MODTIME="1333012233887" AVAILABILITYSEVERITY="5"

ATTRIBUTEID="2601" TECHNICIAN="None"

STATUS="warning" MESSAGE="Health of DB2 is warning. Root Cause : 1. Connection Time

1504 > 1500 ms (threshold). "

ANNOTATION="YES" RESOURCEID="10001307" TYPE="DB2-server"

DetailsPageURL="/showresource.do?resourceid=10001307&method=showResourceForResourceID&

PRINTER_FRIENDLY=true"

TYPEDISPLAYNAME="DB2" SHORTMESSAGE="Health is Warning" HEALTHSEVERITY="4" />

</response>

</result>

</AppManager-response>

Example API that is used to get XML of all recent alarms details which are generated after a particular time. http://appwindows:9090/AppManager/xml/ListAlarms?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&time=124886

8798412

Zoho Corporation Pvt. Ltd.

587

ManageEngine Applications Manager : Help Documentation

ListDashboards API

This API fetches the List of Dashboards created in the Server which includes all the widgets configured in the Dashboards as there is no concept of assigning the dashboards/widgets to operators. But the data which is to be populated will be based on the monitors assigned for the user.

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListDashboards?apikey=[ Api Key ]

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/ListDashboards?apikey=[ API Key ]

Response Details:

Field Description

DashboardId This is the username.

DashboardName This is the description of the user account given at the time of creation of user account

Widget WidgetName -- This represents the display name of the widget

WidgetId -- This is the id of the widget created in this dashboard.

WidgetURL -- This is the link to the widget of this dashboard

<AppManager-response uri="/AppManager/xml/ListDashboards">

<Widget WidgetName=" N Monitors" WidgetId="10000040"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000040"/>

<Widget WidgetName="Current Availability " WidgetId="10000044"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000044"/>

<Widget WidgetName="Last 24 Hours / 30 Days Availability History" WidgetId="10000046"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000046"/>

<Widget WidgetName="Last 24 Hours / 30 Days Health History" WidgetId="10000047"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000047"/>

Zoho Corporation Pvt. Ltd.

588

ManageEngine Applications Manager : Help Documentation

<Widget WidgetName="Availability,Health and Alarm Summary" WidgetId="10000048"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000048"/>

<Widget WidgetName="Monitor Groups" WidgetId="10000057"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000057"/>

<Widget WidgetName="Infrastructure Snapshot" WidgetId="10000078"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000078"/>

<Widget WidgetName="Recent 10 Alarms" WidgetId="10000079"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000079"/>

<Widget WidgetName="Performance Metric Widget" WidgetId="10000088"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000088"/>

</Dashboard>

<Widget WidgetName=" N Monitors" WidgetId="10000007"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000005&widgetid=10000007"/>

<Widget WidgetName="Tabular Data" WidgetId="10000008"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000005&widgetid=10000008"/>

<Widget WidgetName="Recent 10 Alarms" WidgetId="10000009"

WidgetURL="/MyPage.do?method=getWidget&pageid=10000005&widgetid=10000009"/>

</Dashboard>

</response>

</result>

</AppManager-response>

JSON Input http://apm-prod1:9090/AppManager/json/ListDashboards?apikey=c4e547c2330e2eb92d3e7af2262da9e9

JSON Response

{"responsecode":"4000","response":{"uri":"/AppManager/json/ListDashboards","result":[{"Widget":[{"WidgetName":

"Monitor

Groups","WidgetId":"20000001","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widg etid=

20000001"},{"WidgetName":"Infrastructure

Snapshot","WidgetId":"20000002","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&wi dgetid=

20000002"},{"WidgetName":"Recent 10

Alarms","WidgetId":"20000003","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widg etid=

20000003"}],"DashboardId":"20000001","DashboardName":"Default Dashboard"}]}}

Zoho Corporation Pvt. Ltd.

589

ManageEngine Applications Manager : Help Documentation

List Monitor API

ManageEngine Applications Manager provides List Monitor API that allows the user to list details of monitor by the following categories.

• By monitor Type

• By monitor ResourceID

• Listing all the added monitors

This API lists all the monitors of a given type that are configured in Applications Manager for the user corresponding to the API Key. This details displayed includes the Health and Availability of the monitor types, image type, Health outages and Critical/Warning/Clear/UP/Down count for each monitor type.

APIs for ListMonitor

1. By monitor Type

http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&type=[ TYPE in

AM_ManagedObject table ]

2. By particular monitor name

http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&resourceid=[ Resourceid ]

3. Listing all the added monitors

http://[ Host ]:[ Port ]/AppManager/xml/ListMonitor?apikey=[ API key ]&type=all

4. API For XML Response

http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListMonitor?apikey=[ API Key ]&type=all

5. For JSON Response

http://[ APM Host ]:[ APM Port ]/AppManager/json/ListMonitor?apikey=[ API Key

]&type=''Windows'

Note: a) For getting both Esx VirtualMachine and HyperV VirtualMachine , we can simply pass VirtualMachine

as type

b) For getting all windows types, pass 'Windows' as type value c) For all network devices (devices added to APM from OPM or OpStor) simply pass 'NWD' as value for

type.

Zoho Corporation Pvt. Ltd.

590

ManageEngine Applications Manager : Help Documentation

Request Parameters

Field

API Key

Type resourceid type

Description

The key generated from "Generate API" option in the Admin tab.

"type=<monitor type>" is used to list all the monitors in a specified monitor type.

<monitor type> is TYPE in AM_ManagedObject table like Linux,

Windows XP, MYSQL-DB-server, Apache-server, UrlMonitor, Tomcatserver, etc.

The resourceid of the monitor

This value specifies the monitor type, to get all monitor types we need to pass 'all' as the value for the field type.

Extra Attributes:

IMAGEPATH

LASTALARMTIME

This monitor type's image path

This is the time at which last alarm has been generated.

Example API that is used to get XML of monitors by monitor type.

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=[ Api Key ]&type=[ Type ]

Example API that is used to get XML of all monitors.

http://app-windows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8

Example API that is used to get XML of a particular monitors. http://appwindows:9090/AppManager/xml/ListMonitor?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&resourceID=1

0000047

Zoho Corporation Pvt. Ltd.

591

ManageEngine Applications Manager : Help Documentation

Example output:

Monitor Details:

DISPLAYNAME Monitor's Display Name

RESOURCE ID

TYPE

Health Details

Monitor's Resource ID

Monitor type like Windows, Linux

Contains HEALTHMESSAGE that gives the Health Root Cause Message, Health

Attribute ID, HEALTHSEVERITY - (5/4/1) - Clear/Warning/Crirical , STATUS -

Clear/Warning/Critical

Availability Details Contains AVAILABILITYMESSAGE that gives the Availability Root Cause Message,

Availability Attribute ID, AVAILABILITYSEVERITY - Up/Down (5/1), STATUS -

UP/Down

Managed True - the monitor is in Managed state, False - the monitor is in Unmanaged State

RESOURCENAME Monitor's Resource Name

DESCRIPTION Description of the Resource like Network Resource

RCAPageURL URL that links to Root Cause Analysis details

DetailsPageURL URL that links to details page of the monitor

LASTALARMTIME This is the time at which last alarm has been generated.

<AppManager-response uri="/AppManager/xml/ListMonitor">

<Monitor

DetailsPageURL="/showresource.do?resourceid=10001267&method=showResourceForResourceID&

PRINTER_FRIENDLY=true" HEALTHATTRIBUTEID="1651"

Zoho Corporation Pvt. Ltd.

592

ManageEngine Applications Manager : Help Documentation

RESOURCENAME="app-xp2.csez.zohocorpin.com" Managed="true" HEALTHSEVERITY="5"

AVAILABILITYATTRIBUTEID="1650"

AVAILABILITYMESSAGE="Resource up. The resource APM-Windows is available."

TYPESHORTNAME="Windows" TYPE="Windows XP" DESCRIPTION="Network Resource"

AVAILABILITYSEVERITY="5" RESOURCEID="10001267" HEALTHMESSAGE="Health of

APM-Windows is clear. Root Cause : 1. Data Collection Successful 2. APM-Windows is up "

DISPLAYNAME="APM-Windows" RCAPageURL="/jsp/RCA.jsp?resourceid=10001267&attributeid=1651"

HEALTHSTATUS="clear" IMAGEPATH="/images/icon_monitors_windows.gif"

AVAILABILITYSTATUS="up" LASTALARMTIME="1332829401029"/>

<Monitor

DetailsPageURL="/showresource.do?resourceid=10001306&method=showResourceForResourceID&

PRINTER_FRIENDLY=true" HEALTHATTRIBUTEID="1651"

RESOURCENAME="app-xp1.csez.zohocorpin.com" Managed="true" HEALTHSEVERITY="5"

AVAILABILITYATTRIBUTEID="1650"

AVAILABILITYMESSAGE="Resource up. The resource app-xp1 is available."

TYPESHORTNAME="Windows" TYPE="Windows XP" DESCRIPTION="Network Resource"

AVAILABILITYSEVERITY="5" RESOURCEID="10001306" HEALTHMESSAGE="Health of app-xp1 is clear. Root Cause : 1. Data Collection Successful 2. app-xp1 is up "

DISPLAYNAME="app-xp1" RCAPageURL="/jsp/RCA.jsp?resourceid=10001306&attributeid=1651"

HEALTHSTATUS="clear" IMAGEPATH="/images/icon_monitors_windows.gif"

AVAILABILITYSTATUS="up" LASTALARMTIME="1333002612246"/>

</response>

</result>

</AppManager-response>

Zoho Corporation Pvt. Ltd.

593

ManageEngine Applications Manager : Help Documentation

ListMonitorGroups API

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

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

]&groupId=10000035

Request Parameters:

Field Description type groupId

To get all monitor groups we need to pass 'all' as the value for the field type.

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

DetailsPageURL

TODAYUNAVAILPERCENT

AvailabilityRCAURL

Description

This is the url for the details page of the monitor group

This value represents the today's unavailability perecentage

This represents the Availability RCA Url.

Zoho Corporation Pvt. Ltd.

594

Field

ManageEngine Applications Manager : Help Documentation

Description

Action

CRITICALCOUNT

NAME \ DISPLAYNAME

DOWNCOUNT

This represents the critical monitors/monitorgroups count

This Represents the displayname of the monitor group

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 status of the monitor group whether actions or enabled or not

HealthUnknownCount

AVAILABILITYSEVERITY

AVAILABILITYMESSAGE

RESOURCEID

CLEARCOUNT

UPCOUNT

HealthRCAURL

TODAYUNMANGDPERCENT

HEALTHMESSAGE

AvailabilityUnknownCount

OUTAGES

WARNINGCOUNT

HEALTHSTATUS

This represents the severity of the health for this Monitor group (1critical, 4-warning & 5-clear)

This represents the number of monitors or subgroups for which the health is unknown.

This represents the severity of the availability for this monitor group

(1-down , 5-up)

This is the availability message for this group

This is the resourceid of the monitor group.

This represents the number of monitors or subgroups for which the health is clear.

This represents the number of monitors or subgroups for which the availability is up.

This represents the link which show the Health RCA of this group.

This value represents the today's unmanaged perecentage

This is the health message for this group

This represents the number of monitors or subgroups for which the availability is unknown.

This represents the number of monitors or subgroups for which the health is not clear.

This represents the number of monitors or subgroups for which the health is warning.

This represents health status of this group (CRITICAL / CLEAR /

WARNING)

AVAILABILITYSTATUS

SubMonitorGroup

This represents availablility status of this group (UP/ DOWN)

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

Zoho Corporation Pvt. Ltd.

595

Field

ManageEngine Applications Manager : Help Documentation

Description

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">

<MonitorGroup

DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000036& method=showApplication"

TODAYUNAVAILPERCENT="0.0"

AvailabilityRCAURL="/jsp/RCA.jsp?resourceid=10000036&attributeid=17" Action="enabled"

CRITICALCOUNT="0" NAME="Applications Manager"

DOWNCOUNT="0" TODAYAVAILPERCENT="100.0" TODAYSCHEDDOWNPERCENT="0.0"

Type="Monitor Group" HEALTHSEVERITY="5" HealthUnknownCount="0"

AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource Applications Manager is up.

Root Cause : Resource is Up"RESOURCEID="10000036" CLEARCOUNT="5" UPCOUNT="5"

HealthRCAURL="/jsp/RCA.jsp?resourceid=10000036&attributeid=18"

Zoho Corporation Pvt. Ltd.

596

ManageEngine Applications Manager : Help Documentation

TODAYUNMANGDPERCENT="0.0" HEALTHMESSAGE="Health of Applications Manager is clear.

Root Cause : Health is Clear"

AvailabilityUnknownCount="0" OUTAGES="0/5" DISPLAYNAME="Applications Manager_karthi-0031"

WARNINGCOUNT="0" HEALTHSTATUS="clear" AVAILABILITYSTATUS="up" />

</MonitorGroups>

</response>

</result>

</AppManager-response>

JSON Input http://apm-prod1:9090/AppManager/json/ListMonitorGroups?apikey= c4e547c2330e2eb92d3e7af2262da9e9&groupId=10000035

JSON Response

{"response-code":"4000","response":{"uri":"/AppManager/json/ListMonitorGroups","result":[

{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID&resourceid=

20000036&method=showApplication","TODAYUNAVAILPERCENT":"100.0","AvailabilityRCAURL":

"/jsp/RCA.jsp?resourceid=20000036&attributeid=17","Action":"enabled","CRITICALCOUNT":"1","NAME":

"Applications Manager","DOWNCOUNT":"1","TODAYAVAILPERCENT":"0.0","

TODAYSCHEDDOWNPERCENT":"0.0","Type":"Monitor Group","HEALTHSEVERITY":"1","

HealthUnknownCount":"0","AVAILABILITYSEVERITY":"1","AVAILABILITYMESSAGE":"Resource

Applications Manager is down. Root Cause : <ol><li>Resource down. The resource

AppManager Home Page is not available.Connection Timed Out. Increase the time out level:

ResponseCode -200 -->><\/li><\/ol>","RESOURCEID":"20000036","CLEARCOUNT":"2","

UPCOUNT":"2","Health

RCAURL":"/jsp/RCA.jsp?resourceid=20000036&attributeid=18","TODAYUNMANGDPERCENT":"0.0","

HEALTHMESSAGE":"Health of Applications Manager is Critical. Root Cause : <ol>

<li>Health of AppManager Home Page is critical. Root Cause : 1. AppManager Home

Page is down <\/li><\/ol>","AvailabilityUnknownCount":"0","OUTAGES":"1/3","DISPLAYNAME":

"Applications

Manager","WARNINGCOUNT":"0","HEALTHSTATUS":"critical","AVAILABILITYSTATUS":"down"}]}}

Zoho Corporation Pvt. Ltd.

597

ManageEngine Applications Manager : Help Documentation

ListMGDetails API

This API will fetch the Monitor Group Details of the given monitor group id which includes all the subgroups 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

NAME \ DISPLAYNAME

DetailsPageURL

TODAYUNAVAILPERCENT

Action

Description

This is the displayname of this group

This is the url for the details page of this group

This the today's unavailability percentage of this group

This represents whether action is enabled or not

Zoho Corporation Pvt. Ltd.

598

Field

ManageEngine Applications Manager : Help Documentation

Description

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

HEALTHSEVERITY

AVAILABILITYSEVERITY

AVAILABILITYMESSAGE

This represents the type

This represents the severity of the health for this group

This represents the severity of the availability for this group

This represents the availability message for this group

RESOURCEID

HealthRCAURL

TODAYUNMANGDPERCENT

HEALTHMESSAGE

HEALTHSTATUS

AVAILABILITYSTATUS

SubMonitorGroup

This is the resourceid of this group

This is the health RCA url of this group

This is the today's unamanaged percentage of this monitor group

This represents the health message for this group

This is the health status of this group

This is the availability status of this 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

Zoho Corporation Pvt. Ltd.

599

Field

Monitors

ManageEngine Applications Manager : Help Documentation

Description

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

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

Zoho Corporation Pvt. Ltd.

600

Field

ManageEngine Applications Manager : Help Documentation

Description 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">

<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. Root Cause : Resource is

Up" RESOURCEID="10000035" HealthRCAURL="/jsp/RCA.jsp?resourceid=10000035&attributeid=18"

TODAYUNMANGDPERCENT="0.0" HEALTHMESSAGE="Health of Applications Manager is critical.

Root Cause :

<ol>

<li>Health of pavankumar-0549 is critical. Root Cause : 1. Application Layer Gateway Service is down 2. Application Identity is down 3. Application Information is down </li><li>Health of appman sub1 is critical.

Root Cause : <ol><li>Health of pavankumar-0549 is critical. Root Cause :

1. Application Layer Gateway Service is down 2. Application Identity is down

3. Application Information is down </li></ol></li><li>Health of pavankumar-0549_Tomcat

Server_9090 is critical. Root Cause : 1. Average Response Time 2694 > 2000 ms

(threshold). </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" TODAYSCHED

DOWNPERCENT="0" HEALTHSEVERITY="5" TYPE="MSSQL-DB-server"

AVAILABILITYSEVERITY="5" AVAILABILITYMESSAGE="Resource up. 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. Root Cause :

Zoho Corporation Pvt. Ltd.

601

ManageEngine Applications Manager : Help Documentation

1. 127.0.0.1_MS SQL_pavansqlexpress is up 2. Buffer Hit Ratio 100 > 90 % (threshold).

3. is clear. 4. master is ONLINE 5. model is ONLINE 6. msdb is ONLINE

7. tempdb is ONLINE 8. AMDB_10100 is ONLINE 9. AMDB_10030 is ONLINE

10. AMDB_test is ONLINE 11. syspolicy_purge_history --> Scheduled Job syspolicy_purge_history. is clear. 12. AMDB_app_xp4_admin is ONLINE

13. AMDB_app_xp4_admin1 is ONLINE 14. AMDB_pavan_admin is

ONLINE 15. AMDB_pavan_MANAGED is ONLINE 16. AMDB_imac is ONLINE

17. AMDB_ADMIN is ONLINE 18. AMD_10100 is ONLINE 19. AMDB_sahad is ONLINE

" 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. 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.

Root Cause :

1. AppManager Home Page is up 2. Response Time 33 <= 1500 ms (threshold).

" 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. 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.

Root Cause : 1. Application Layer Gateway

Service is down 2. Application Identity is down 3. Application Information is down

" 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. 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.

Root Cause : 1. Response Time 24 <= 1500 ms (threshold). 2. pavankumar-0549-9090 is up " HEALTHSTATUS="clear" DISPALYNAME="pavankumar-0549-9090"

AVAILABILITYSTATUS="up"/>

<Monitors

DetailsPageURL="/showresource.do?method=showResourceForResourceID&resourceid=10000043&

Zoho Corporation Pvt. Ltd.

602

ManageEngine Applications Manager : Help Documentation 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. 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.

Root Cause : 1. pavankumar-0549_Apache Server_9090 is up 2. Response Time

6 <= 1500 ms (threshold). " 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.

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.

Root Cause : 1. Average Response Time 2694 > 2000 ms (threshold). "

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. Root Cause :

Resource is Up" RESOURCEID="10000267" HealthRCAURL="/jsp/RCA.jsp? resourceid=10000267&attributeid=18" TODAYUNMANGDPERCENT="0.0"

HEALTHMESSAGE="Health of appman sub1 is critical. Root Cause : <ol>

<li>Health of pavankumar-0549 is critical. Root Cause : 1. Application Layer

Gateway Service is down 2. Application Identity is down 3. Application Information is down </li></ol>" HEALTHSTATUS="critical" DISPALYNAME="appman sub1"

AVAILABILITYSTATUS="up"/>

<SubMonitorGroup DetailsPageURL="/showresource.do?method=showResourceFor

ResourceID&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"

Zoho Corporation Pvt. Ltd.

603

ManageEngine Applications Manager : Help Documentation

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

{"responsecode":"4000","response":{"uri":"/AppManager/json/ListMGDetails","result":[{"DetailsPageURL":"/ showresource.do?method=showResourceForResourceID&resourceid=20000036&method=show

Application","Monitors":[{"DetailsPageURL":"/showresource.do?method=showResourceForResourceID

&resourceid=20000043&method=showApplication","TODAYUNAVAILPERCENT":"0","Availability

RCAURL":"/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","TODAYUNMANGD

PERCENT":"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

Zoho Corporation Pvt. Ltd.

604

ManageEngine Applications Manager : Help Documentation of apm-prod1_Apache Server_9090 is clear. Root Cause : 1. apm-prod1_

Apache Server_9090 is up 2. Response Time 16 <= 1500 ms (threshold). ",

"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 : <ol><li>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 : <ol>

<li>Health of AppManager Home Page is critical. Root Cause : 1. AppManager Home Page is down <\/li><\/ol>","DISPLAYNAME":"Applications Manager","HEALTHSTATUS":"critical",

"AVAILABILITYSTATUS":"down"}]}}

Zoho Corporation Pvt. Ltd.

605

ManageEngine Applications Manager : Help Documentation

ListMonitorTypes API

This API will list all the monitor types configured in the Applications Manager for the user corresponding to the API Key. The details include the Health and Availability of the monitor types, type image, Health outages, Critical/Warning/Clear/UP/Down count for each and every monitor type.

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListMonitorTypes?apikey=[ API Key ]&type=all

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/ListMonitorTypes?apikey=[ API Key ]&type=all

NOTE:

We hope to support the others in future, depending on popular customer demand.

Response Details:

Field Description

AVAILUNKNOWNCOUNT

IMAGE

CRITICALCOUNT

SUBGROUP \

RESCATEGORY

DOWNCOUNT

HEALTHSEVERITY

HEALTHMSG

This is the count of number of monitors for which availability is unknown.

This is the image path for the monitor type

This is the count of number of monitors for which health is critical in a type

This represent the category under which it belongs to. (IIS-Server, Mail-

Server, etc.,)

This is the count of number of monitors for which availability is down in a type

This is the severity of the health (1-critical, 4-warning and 5-clear)

This is the health message for this monitor type

Zoho Corporation Pvt. Ltd.

606

Field

RESCATEGORY

ManageEngine Applications Manager : Help Documentation

Description

This represents the group under which this monitor type is grouped. like

(servers, Databases, etc.,)

UPCOUNT

CLEARCOUNT

OUTAGES

DISPLAYNAME

WARNINGCOUNT

This is the count of number of monitors for which availability is up in a type

This is the count of number of monitors for which health is clear in a type

This is the health outages w.r.t the total number of monitors in this type

This is the displayname of the monitor type

This is the count of number of monitors for which health is warning in a type

This is the availability message for this monitor type AVAILMSG

COUNT This is the total number of monitors in this type

HEALTHUNKNOWNCOUNT This is the count of number of monitors for which health is unknown in a type

RESOURCETYPEURL

AVAILSEVERITY

This is the url of the page where all the monitor's of this type will be listed.

This is the severity of the availability for this type (clear -5, down -1)

Zoho Corporation Pvt. Ltd.

607

ManageEngine Applications Manager : Help Documentation

<AppManager-response uri="/AppManager/json/ListMonitorTypes">

<MonitorType AVAILUNKNOWNCOUNT="0" IMAGE="/images/icon_monitors_solaris.gif"

CRITICALCOUNT="0" SUBGROUP="Sun Solaris" DOWNCOUNT="0" HEALTHSEVERITY="5"

HEALTHMSG="Health is clear. Root Cause: 1. Health of Sunsolaris is clear "

RESCATEGORY="SYS" UPCOUNT="1" CLEARCOUNT="1" OUTAGES="0/1" DISPLAYNAME=

"Sun Solaris" WARNINGCOUNT="0" AVAILMSG="Resource is up. Root Cause:

1. Sunsolaris is up " COUNT="1" HEALTHUNKNOWNCOUNT="0"

RESOURCETYPEURL="/showresource.do?method=showResourceTypes&direct=true& network=Sun Solaris&detailspage=true&PRINTER_FRIENDLY=true" AVAILSEVERITY="5"/>

<MonitorType AVAILUNKNOWNCOUNT="0" IMAGE="/images/icon_monitor_vmware.gif"

CRITICALCOUNT="7" SUBGROUP="VirtualMachine" DOWNCOUNT="8" HEALTHSEVERITY="1"

HEALTHMSG="Health is critical. Root Cause: 1. Health of amp-vm-centos64 is critical

2. Health of opman-xp32-2-test is critical 3. Health of opman-ubuntu10-1-ttt11 is critical

4. Health of tes-111-5689-linux-2 is critical 5. Health of opman-ubuntu10-6-test2 is critical

6. Health of Jim Linux Box is critical 7. Health of ICONVM is critical

" RESCATEGORY="VIR" UPCOUNT="8" CLEARCOUNT="8" OUTAGES="7/16"

DISPLAYNAME="Virtual Machine" WARNINGCOUNT="0" AVAILMSG="Resource is down.

Root Cause: 1. amp-vm-centos64 is down 2. null is down

3. opman-xp32-2-test is down 4. opman-ubuntu10-1-ttt11 is down

5. tes-111-5689-linux-2 is down 6. opman-ubuntu10-6-test2 is down 7. Jim Linux

Box is down 8. ICONVM is down " COUNT="16" HEALTHUNKNOWNCOUNT="1"

RESOURCETYPEURL="/showresource.do?method=showResourceTypes&direct=true&network=

VirtualMachine&detailspage=true&PRINTER_FRIENDLY=true" AVAILSEVERITY="1"/>

<MonitorType AVAILUNKNOWNCOUNT="0" IMAGE="/images/icon_monitor_SSL.gif"

CRITICALCOUNT="0" SUBGROUP="SSLCertificateMonitor" DOWNCOUNT="0"

HEALTHSEVERITY="5"

HEALTHMSG="Health is clear. Root Cause: 1. Health of ZOHO is clear

" RESCATEGORY="URL" UPCOUNT="1" CLEARCOUNT="1" OUTAGES="0/1"

DISPLAYNAME="SSL Certificate Monitor" WARNINGCOUNT="0" AVAILMSG="Resource is up.

Root Cause: 1. ZOHO is up " COUNT="1" HEALTHUNKNOWNCOUNT="0"

RESOURCETYPEURL="/showresource.do?method=showResourceTypes&direct=true& network=SSLCertificateMonitor&detailspage=true&PRINTER_FRIENDLY=true" AVAILSEVERITY="5"/>

</response>

</result>

</AppManager-response>

Zoho Corporation Pvt. Ltd.

608

ManageEngine Applications Manager : Help Documentation

JSON Input http://apmprod1:9090/AppManager/json/ListMonitorTypes?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type=all

JSON Response

{"response-code":"4000","response":{"uri":"/AppManager/json/ListMonitorTypes",

"result":[{"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitors_urlmonitor.gif",

"CRITICALCOUNT":"1","SUBGROUP":"UrlMonitor","DOWNCOUNT":"1","HEALTHSEVERITY":

"1","HEALTHMSG":"Health is critical. Root Cause: 1. Health of AppManager Home

Page is critical ","RESCATEGORY":"URL","UPCOUNT":"0","CLEARCOUNT":"0",

"OUTAGES":"1/1","DISPLAYNAME":"HTTP(s) URLs","WARNINGCOUNT":"0","AVAILMSG":

"Resource is down. Root Cause: 1. AppManager Home Page is down "

,"COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":

"/showresource.do?method=showResourceTypes&direct=true&network=UrlMonitor& detailspage=true&PRINTER_FRIENDLY=true","AVAILSEVERITY":"1"},{"AVAILUNKNOWNCOUNT":

"0","IMAGE":"/images/icon_monitors_apache.gif","CRITICALCOUNT":"0","SUBGROUP":

"Apache-server","DOWNCOUNT":"0","HEALTHSEVERITY":"5","HEALTHMSG":"Health is clear.

Root Cause: 1. Health of apm-prod1_Apache Server_9090 is clear ",

"RESCATEGORY":"URL","UPCOUNT":"1","CLEARCOUNT":"1","OUTAGES":"0/1",

"DISPLAYNAME":"Apache Server","WARNINGCOUNT":"0","AVAILMSG":

"Resource is up. Root Cause: 1. apm-prod1_Apache Server_9090 is up ",

"COUNT":"1","HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":"/showresource.do? method=showResourceTypes&direct=true&network=Apache-server&detailspage=true&

PRINTER_FRIENDLY=true","AVAILSEVERITY":"5"}

,{"AVAILUNKNOWNCOUNT":"0","IMAGE":"/images/icon_monitors_windows.gif","

CRITICALCOUNT":"0","SUBGROUP":"Windows","DOWNCOUNT":"0","HEALTHSEVERITY":

"5","HEALTHMSG":"Health is clear. Root Cause: 1. Health of apm-prod1_Windows

Vista is clear ","RESCATEGORY":"SYS","UPCOUNT":"1","CLEARCOUNT":"1","OUTAGES":"0/1"

,"DISPLAYNAME":"Windows","WARNINGCOUNT":"0","AVAILMSG":"Resource is up.

Root Cause: 1. apm-prod1_Windows Vista is up ","COUNT":"1",

"HEALTHUNKNOWNCOUNT":"0","RESOURCETYPEURL":

"/showresource.do?method=showResourceTypes&direct=true&network=Windows

&detailspage=true&PRINTER_FRIENDLY=true","AVAILSEVERITY":"5"}]}}

Zoho Corporation Pvt. Ltd.

609

ManageEngine Applications Manager : Help Documentation

List Server API

ManageEngine Applications Manager provides List Server API that allows the user to list information about the server by the following categories.

• Listing all the server details.

• By particular server name.

• By IP Address of server.

APIs for ListServer:

1. Listing all the added servers

http://[ Host ]:[ Port ]/AppManager/xml/ListServer?apikey=[ API key ]&type=all

2. By server name

http://[ Host ]:[ Port ]/AppManager/xml/ListServer?apikey=[ API key ]&type=[ Server display name ]

3. By IP Address

http://[ Host ]:[ Port ]/AppManager/xml/ListServer?apikey=[ API key ]&ipaddress=[ IP Address of server ]

Request Parameters

Field Description

API Key

Type ipaddress

The key generated from "Generate API " option in the Admin tab.

"type=<Server PARENTNODE name>" is used to list details of specified server in Applications Manager

< Server PARENTNODE name> is PARENTNODE in IpAddress table.

ipaddress = [IP Address of server]

Example API that is used to get the XMLof all servers and their services details http://app-

windows:9090/AppManager/xml/ListServer?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&type=all

Zoho Corporation Pvt. Ltd.

610

ManageEngine Applications Manager : Help Documentation

Example API that is used to get XML of a particular server and it's services details. http://appwindows:9090/AppManager/xml/ListServer?apikey=65d0fa3e1f6c6bdcce1c3969f24c39a8&type=app-

windows

API for XML Response :

http://[ APM Host ]:[ APM Port ]/AppManager/xml/ListServer?apikey=[ API Key ]&type=all

API for JSON Response :

http://[ APM Host ]:[ APM Port ]/AppManager/json/ListServer?apikey=[ API Key ]&type=all

Example output:

Server Details:

Server Name Name of the Server

Parent IP Parent Network IP address of the Server resourceid

Type

DISPLAYNAME

IPADDRESS

Service Details

Resource ID of the Server

Server Type like Windows

Display Name of the Server like XP1

IP Address of the Server

Contains information about the services running in the server.

Service DISPLAYNAME - Display Name of the Service

TYPE - Type of the service like SNMP

RESOURCEID - Resource ID of the Service

RCALink

DetailsPageLink

RESOURCENAME - Resource Name of the Service

DESCRIPTION - Description of the Resource like Network Resource

ATTRIBUTEID - Service Attribute ID

Link to Root Cause Analysis details

Link to the Details page of the Server

<AppManager-response uri="/AppManager/xml/ListServer">

Zoho Corporation Pvt. Ltd.

611

ManageEngine Applications Manager : Help Documentation

<Server DISPLAYNAME="pavankumar-0549" RESOURCEID="10000038" Name="pavankumar-

0549.csez.zohocorpin.com" PARENTIP="10.0.0.0" IPADDRESS="192.168.24.211" TYPE="Windows 7">

<Service ATTRIBUTEID="2100" RESOURCEID="10000043" DISPLAYNAME="pavankumar-

0549_Apache Server_9090" DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-

0549.csez.zohocorpin.com_Apache-server_9090"

DetailsPageLink="/showresource.do?resourceid=10000043&method=showResourceForResourceID"

RCALink="/jsp/RCA.jsp?resourceid=10000043&attributeid=2100" TYPE="Apache"/>

<Service ATTRIBUTEID="152" RESOURCEID="10000044" DISPLAYNAME="pavankumar-0549-9090"

DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-

0549.csez.zohocorpin.com_Port-Test_9090"

DetailsPageLink="/showresource.do?resourceid=10000044&method=showResourceForResourceID"

RCALink="/jsp/RCA.jsp?resourceid=10000044&attributeid=152" TYPE="Service Monitoring"/>

<Service ATTRIBUTEID="15" RESOURCEID="10000055" DISPLAYNAME="pavankumar-0549_Tomcat

Server_9090" DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-

0549.csez.zohocorpin.com_Tomcat-server_9090"

DetailsPageLink="/showresource.do?resourceid=10000055&method=showResourceForResourceID"

RCALink="/jsp/RCA.jsp?resourceid=10000055&attributeid=15" TYPE="Tomcat"/>

<Service ATTRIBUTEID="2000" RESOURCEID="10000149" DISPLAYNAME="pavankumar-0549"

DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-

0549.csez.zohocorpin.com_IIS-server_80"

DetailsPageLink="/showresource.do?resourceid=10000149&method=showResourceForResourceID"

RCALink="/jsp/RCA.jsp?resourceid=10000149&attributeid=2000" TYPE="IIS"/>

<Service ATTRIBUTEID="3301" RESOURCEID="10000154" DISPLAYNAME="pavankumar-0549 dot net" DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-

0549.csez.zohocorpin.com_.NET"

DetailsPageLink="/showresource.do?resourceid=10000154&method=showResourceForResourceID"

RCALink="/jsp/RCA.jsp?resourceid=10000154&attributeid=3301" TYPE=".NET"/>

</Server>

</response>

</result>

</AppManager-response>

Zoho Corporation Pvt. Ltd.

612

ManageEngine Applications Manager : Help Documentation

Search API

This API will fetch the List of Monitors / Monitor Groups that matches the query string and the search condition. Also the search will be with in the list of monitors assigned to the user.

API for XML Response: http://[ APM Host ]:[ APM Port ]/AppManager/xml/Search?apikey=[ API

Key]&query=[query]&searchCondition=[searchCondition]

API for JSON Response: http://[ APM Host ]:[ APM Port ]/AppManager/json/Search?apikey=[ API

Key]&query=[query]&searchCondition=[searchCondition]

Request Parameters:

Field Description query This value specifies the string that has to be searched in the monitors list associated to an user.

Additional Parameters:

Field Description searchCondition This value specifies the type of monitor that has to be searched in the monitors list associated to an user. For example - displayname, monitortype, ipaddress and customfields

Zoho Corporation Pvt. Ltd.

613

ManageEngine Applications Manager : Help Documentation

Response Details:

Field Description

Type This represents the type of the element got in search results

HealthStatus This is health status of the search element

AvailabilityMessage This is the availability message of the search element

DisplayName

ManagedServer

This is the displayname of the search element

This is the managed server name in which the monitor or group is added.It will have 'NA' as value for professional edition

AvailabilityStatus This is availability status of the search element

SubGroup This is category to which the elements belongs to.

ResourceId

HealthMessage

HealthSeverity

ImagePath

This is the resource id of the search element.

This is the health message of the search element

This is the health severity of the search element

This is monitor type/ monitor group image path

AvailabilitySeverity This is the availability severity of the search element

DetailsPageURL This is details page of the search element.

Zoho Corporation Pvt. Ltd.

614

ManageEngine Applications Manager : Help Documentation

<response response-code="4000"><Monitor Type="Linux" HealthStatus="clear" AvailabilityMessage=

"Resource up. The resource karthi linux is available." DisplayName="karthi linux"

ManagedServer="Admin Server" AvailabilityStatus="up" SubGroup="Linux"

ResourceId="10000117" HealthMessage="Health of karthi linux is clear. Root Cause :

1. karthi linux is up 2. Data Collection Successful " HealthSeverity="5"

ImagePath="/images/icon_monitors_linux.gif" AvailabilitySeverity="5"

DetailsPageURL="/showresource.do?resourceid=10000117&method=showResource

ForResourceID&PRINTER_FRIENDLY=true"/><Monitor Type="Linux" HealthStatus="clear"

AvailabilityMessage="Resource up. The resource app-centos32-1 is available."

DisplayName="app-centos32-1" ManagedServer="Admin Server" AvailabilityStatus="up"

SubGroup="Linux" ResourceId="10000108" HealthMessage="Health of app-centos32-1 is clear.

Root Cause : 1. app-centos32-1 is up 2. Data Collection Successful " HealthSeverity="5"

ImagePath="/images/icon_monitors_linux.gif" AvailabilitySeverity="5"

DetailsPageURL="/showresource.do?resourceid=10000108&method=showResourceFor

ResourceID&PRINTER_FRIENDLY=true"/><Monitor Type="Linux" HealthStatus="clear"

AvailabilityMessage="Resource up. The resource prasadh linux is available."

DisplayName="prasadh linux" ManagedServer="Admin Server" AvailabilityStatus="up"

SubGroup="Linux" ResourceId="10000071" HealthMessage="Health of prasadh linux is clear.

Root Cause : 1. prasadh linux is up 2. Data Collection Successful " HealthSeverity="5"

ImagePath="/images/icon_monitors_linux.gif" AvailabilitySeverity="5"

DetailsPageURL="/showresource.do?resourceid=10000071&method=showResourceFor

ResourceID&PRINTER_FRIENDLY=true"/></response>

JSON Input http://apm-prod1:9090/AppManager/json/Search? apikey=4f77fe9c75f4472764a07846bf7f032d&query=linux&searchCondition=monitortype

JSON Response

{"response":{"result":[{"Type":"Linux","HealthStatus":"clear","AvailabilityMessage":

"Resource up. The resource app-centos32-1 is available.","DisplayName":

"app-centos32-1","ManagedServer":"Admin Server","AvailabilityStatus":"up",

"SubGroup":"Linux","ResourceId":"10000108","HealthMessage":"Health of app-centos32-1 is clear. Root Cause : 1. app-centos32-1 is up

2. Data Collection

Successful ","HealthSeverity":"5","ImagePath":"/images/icon_monitors_linux.gif",

"AvailabilitySeverity":"5","DetailsPageURL":"/showresource.do?resourceid=10000108

&method=showResourceForResourceID&PRINTER_FRIENDLY=true"},{"Type"

:"Linux","HealthStatus":"clear","AvailabilityMessage":"Resource up.

Zoho Corporation Pvt. Ltd.

615

ManageEngine Applications Manager : Help Documentation

The resource karthi linux is available.","DisplayName":"karthi linux","ManagedServer":"

Admin Server","AvailabilityStatus":"up","SubGroup":"Linux","ResourceId":"10000117","

HealthMessage":"Health of karthi linux is clear. Root Cause : 1. karthi linux is up

2. Data Collection Successful ","HealthSeverity":"5","ImagePath":"/images/icon_monitors_linux.gif","

AvailabilitySeverity":"5","DetailsPageURL":"/showresource.do?resourceid=10000117& method=showResourceForResourceID&PRINTER_FRIENDLY=true"},{"Type":"Linux",

"HealthStatus":"clear","AvailabilityMessage":"Resource up. The resource prasadh linux is available.","DisplayName":"prasadh linux","ManagedServer":"Admin

Server","AvailabilityStatus":"up","SubGroup":"Linux","ResourceId":"10000071","HealthMessage":"Health of prasadh linux is clear. Root Cause : 1. prasadh linux is up 2. Data Collection

Successful ","HealthSeverity":"5","ImagePath":"/images/icon_monitors_linux.gif","

AvailabilitySeverity":"5","DetailsPageURL":"/showresource.do?resourceid=10000071& method=showResourceForResourceID&PRINTER_FRIENDLY=true"}],"uri":"/AppManager/json/Search"}," response-code":"4000"}

Zoho Corporation Pvt. Ltd.

616

ManageEngine Applications Manager : Help Documentation

ShowPolledData API

This API will fetch the List of Dashboards created in the Server which includes all the widgets configured in the Dashboards as there is no concept of assigning the dashboards/widgets to operators. But the data which is gonna be populated will be based on the monitors assigned for the user.

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/ShowPolledData?apikey=[ API Key ]

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/ShowPolledData?apikey=[ API Key ]

Request Parameters:

Field Description resourceid attributeID

This value is the resourceid of the monitor from which the data has to be fetched.

This is the value of the attribute id for which the polled or archived data has to be shown. period This value specifies the the type of data that needs to be returned. its values are : 20 for show polled data, -7 for 7 days archieved data and -

30 for 30 days archieved data.

Example urls:

Polled Data:

API for XML Response: http://[ APM Host ]:[ APM Port

]/AppManager/xml/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042

&period=20&attributeID=310

Zoho Corporation Pvt. Ltd.

617

ManageEngine Applications Manager : Help Documentation

API for JSON Response: http://[ APM Host ]:[ APM Port

]/AppManager/json/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042

&period=20&attributeID=3102

Last 7 days Data:

API for XML Response: http://[ APM Host ]:[ APM Port

]/AppManager/xml/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042

&period=-7&attributeID=3102

API for JSON Response: http://[ APM Host ]:[ APM Port

]/AppManager/json/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042

&period=-7&attributeID=3102

Last 30 days Data:

API for XML Response: http://[ APM Host ]:[ APM Port

]/AppManager/xml/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042

&period=-30&attributeID=3102

API for JSON Response: http://[ APM Host ]:[ APM Port

]/AppManager/json/showPolledData?apikey=8c8ec3f2cd30722d3a6f980df12c1e5f&resourceid=10000042

&period=-30&attributeID=3102

Response Details:

Field Description

StartTime

EndTime

This is the start time in milli seconds format from which 7/30/ show polled data report is generated

This is the end time in milli seconds format from which 7/30/ show polled data report is generated

Zoho Corporation Pvt. Ltd.

618

Field

StartDateTime

EndDateTime

ResourceName

ResourceType

AttributeName

Unit

AttributeID

ReportType

BusinessPeriod

ResourceId

AttributeImage

Status

Period

RawData

ArchiveData

ManageEngine Applications Manager : Help Documentation

Description

This is the start time in date time format from which 7/30/ show polled data report is generated

This is the end time in date time format from which 7/30/ show polled data report is generated

This is the monitor name from which the data is returned

This is the type of the resource for which the data is returned

This is the name of the attribute

This is the units of the attribute

This is the ID of the user

This is the type of data this API call is returning (Polled data / 7 days data / 30 days data).

This represents the business period name

This is the monitor resourceid

This is the attribute graph for the data returned along with this response.

This is the status of the REST API call to get the show polled data

This value specifies the the type of data that needs to be returned. its values are : 20 for show polled data, -7 for 7 days archieved data and -

30 for 30 days archieved data.

• CollectionTime -- represents the time stamp in ms at which the data is collected

• DateTime -- represents the time stamp in date time format at which the data is collected

• Value -- this represents the value of the attribute

• ArchivedTime -- represents the archived time in ms

• DateTime -- represents the archived time in data time format

• AvgValue -- this is the avg time of the value in that archived period

• MinValue -- this is the minimum value in that archived period

• MaxValue -- this is the maximum value in that archived period

Zoho Corporation Pvt. Ltd.

619

ManageEngine Applications Manager : Help Documentation

<AppManager-response uri="/AppManager/xml/ShowPolledData">

<Monitorinfo StartTime="1328775260450" EndDateTime="Mar 29, 2012 3:00 PM"

ResourceName="APM-Windows" Unit="ms" EndTime="1333013434474" BusinessPeriod="NA"

MonitorType="Response Time" ReportType="Polled data" ResourceId="10001267" AttributeID="4602"

AttributeImage="/webclient/temp/images/RSVmYs.jpg" ServerType="GlassFish" Status="SUCCESS"

StartDateTime="Feb 9, 2012 1:44 PM" Period="20">

</Monitorinfo>

</response>

</result>

</AppManager-response>

JSON Input http://apm-prod1:9090/AppManager/json/ShowPolledData?apikey= c4e547c2330e2eb92d3e7af2262da9e9&resourceid=20000039&period=20&attributeID=1957

JSON Response

{"response-code":"4000","response":{"uri":"/AppManager/json/ShowPolledData","result":

[{"StartTime":"1337928634448","EndDateTime":"May 25, 2012 3:32 PM","ResourceName":

"apm-prod1_Windows

Vista","Unit":"%","EndTime":"1337940130413","BusinessPeriod":"NA","ReportType":"Polled data","ThresholdDetails":[],"ResourceId":"20000039","AttributeName":"CPU

Utilization","AttributeID":"1957","AttributeImage":"/webclient/temp/images/fjrEKg.jpg",

"Status":"SUCCESS","RawData":[{"CollectionTime":"1337940130413","Value":"18","DateTime":"May 25,

2012 3:32 PM"},{"CollectionTime":"1337939525577","Value":"11","DateTime":"May 25, 2012 3:22

PM"},{"CollectionTime":"1337938920641","Value":"5","DateTime":"May 25, 2012 3:12

PM"},{"CollectionTime":"1337938315808","Value":"6","DateTime":"May 25, 2012 3:01

PM"},{"CollectionTime":"1337937710788","Value":"7","DateTime":"May 25, 2012 2:51

PM"},{"CollectionTime":"1337937105838","Value":"7","DateTime":"May 25, 2012 2:41

PM"},{"CollectionTime":"1337936500971","Value":"9","DateTime":"May 25, 2012 2:31

PM"},{"CollectionTime":"1337935895963","Value":"18","DateTime":"May 25, 2012 2:21

Zoho Corporation Pvt. Ltd.

620

ManageEngine Applications Manager : Help Documentation

PM"},{"CollectionTime":"1337935291160","Value":"7","DateTime":"May 25, 2012 2:11

PM"},{"CollectionTime":"1337934686297","Value":"31","DateTime":"May 25, 2012 2:01

PM"},{"CollectionTime":"1337934079880","Value":"13","DateTime":"May 25, 2012 1:51

PM"},{"CollectionTime":"1337933475084","Value":"16","DateTime":"May 25, 2012 1:41

PM"},{"CollectionTime":"1337932869853","Value":"34","DateTime":"May 25, 2012 1:31

PM"},{"CollectionTime":"1337932263739","Value":"8","DateTime":"May 25, 2012 1:21

PM"},{"CollectionTime":"1337931658583","Value":"7","DateTime":"May 25, 2012 1:10

PM"},{"CollectionTime":"1337931053751","Value":"17","DateTime":"May 25, 2012 1:00

PM"},{"CollectionTime":"1337930448921","Value":"9","DateTime":"May 25, 2012 12:50

PM"},{"CollectionTime":"1337929844110","Value":"6","DateTime":"May 25, 2012 12:40

PM"},{"CollectionTime":"1337929239270","Value":"3","DateTime":"May 25, 2012 12:30

PM"},{"CollectionTime":"1337928634448","Value":"9","DateTime":"May 25, 2012 12:20

PM"}],"ResourceType":"Windows Vista","StartDateTime":"May 25, 2012 12:20 PM","Period":"20"}]}}

Zoho Corporation Pvt. Ltd.

621

Oglas

List Data

GetMonitorData API

ListActions API

List Alarms API

ListDashboards API

List Monitor API

ListMonitorGroups API

ListMGDetails API

ListMonitorTypes API

List Server API

Search API

ShowPolledData API

Povezano

ManageEngine Applications Manager Guide | AI Chat & PDF

ManageEngine Applications Manager User Guide

Applications Manager User Guide

Zoho Applications Manager User Guide

Server & Application Monitor Templates Reference

HPE IMC APM WebSphere Application Monitor User Guide

HPE IMC APM SQL Server Application Monitor User Guide

AdventNet ManageEngine AM 6 User Guide | AI Chat & PDF

Yeastar Cloud PBX Integration Guide

Oracle WebLogic Server 12c (12.1.3) Monitoring with SNMP User Manual

ManageEngine ServiceDesk Plus Installation Guide

Oracle Apache Tomcat Guide: AI Chat & PDF Access