Get Monitor Group Availability API


You can use this API is used to pull up availability data on a monitor group in Applications Manager. Depending on the output format that you require, you can use one of the following APIs:

getMonitorGroupAvailabilityInfo API

Sample Request:

http://[hostname]:[port]/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=[REST API Key]

Request Parameters

The parameters involved in the API request are described below:

Field Description
apikey * The key generated from the Generate API Key option in the 'Admin' tab.
IncludeSubGroup Specify 'IncludeSubGroup=true' if you also wish to know the availability status of the sub-group within the monitor group.
CustomTime Specify CustomTime=true for custom time availability report. If CustomTime is true then you must provide StartTime and EndTime.
StartTime The start time of the report in milliseconds.
EndTime The end time of the report in milliseconds.
ReportPeriod

The time period for which the report should be created. If this parameter is not provided then today's availability is shown. Possible values are:

  • 0 = Todays Availability
  • 1 = Last 7 Days Availability
  • 2 = Last 30 Days Availability
  • 3 = Yesterday Availability
  • 5 = Last 1 Year Availability
  • 6 = This week Availability
  • 7 = This month Availability
  • 8 = This year Availability
  • 9 = This quarter Availability
  • 11= Last month Availability
  • 12= Last week Availability
haid

The id of the monitor group. In Applications Manager, you can find the groupID of a monitor group using the following method:

  • Click on the Group Name in the Monitor Groups table. This will open the Monitor Group details page
  • The URL of the Monitor Group details page will be in the following format:

    http://app-windows:9090/showapplication.do?&method=showApplication&haid=10000040

  • The haid in the URL is the Group ID that you require, in this case, 10000040.

* - mandatory

Sample Requests

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d

To include sub-group:

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d&IncludeSubGroup=true

For service availability calculation:

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d&ServiceAvailability=true

For custom time availability report:

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d&CustomTime=true&StartTime=2&EndTime=4

To set the Report Period:

http://localhost:9090/AppManager/json/getMonitorGroupAvailabilityInfo?apikey=833015a191b75b11f953774ab34f034d&ReportPeriod=1

To filter with Haids:

http://localhost:9092/AppManager/xml/getMonitorGroupAvailabilityInfo?apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true&haid=10000

Sample Outputs

Description

Sample Inputs and Outputs

To include sub-group

Input

http://localhost:9092/AppManager/xml/getMonitorGroupAvailabilityInfo?apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true

Output

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

<result>

<response response-code="200">

<Group_Availability>

<Availability ResourceID="10001368" DisplayName="App2-level1" Unavailable="0" Available="100"/>

<Availability ResourceID="10001369" DisplayName="App2-level2" Unavailable="0" Available="100"/>

<Availability ResourceID="10000252" DisplayName="App - 1" Unavailable="100.0" Available="0.0"/>

</Group_Availability>

</response>

</result>

</AppManager-response>

 

getMonitorGroupAvailability API

Sample Request:

http://[hostname]:[port]/AppManager/json/getMonitorGroupAvailability?apikey=[REST API Key]

Request Parameters

The parameters involved in the API request are described below:

Field Description
apikey * The key generated from the Generate API Key option in the 'Admin' tab.
IncludeSubGroup Specify IncludeSubGroup = true if you also wish to know the availability status of the sub-group within the monitor group.
CustomTime Specify CustomTime=true for custom time availability report. If CustomTime is true then you must provide StartTime and EndTime
StartTime The start time of the report in milliseconds.
EndTime The end time of the report in milliseconds.
ReportPeriod

The time period for which the report should be created. If this parameter is not provided then today's availability is shown. Possible values are:

  • 0 = Todays Availability
  • 1 = Last 7 Days Availability
  • 2 = Last 30 Days Availability
  • 3 = Yesterday Availability
  • 5 = Last 1 Year Availability
  • 6 = This week Availability
  • 7 = This month Availability
  • 8 = This year Availability
  • 9 = This quarter Availability
  • 11= Last month Availability
  • 12= Last week Availability
haid

The id of the monitor group. In Applications Manager, you can find the groupID of a monitor group using the following method:

  • Click on the Group Name in the Monitor Groups table. This will open the Monitor Group details page
  • The URL of the Monitor Group details page will be in the following format:

    http://app-windows:9090/showapplication.do?&method=showApplication&haid=10000040

  • The haid in the URL is the Group ID that you require, in this case, 10000040.

* - mandatory

Sample requests:

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d

To include sub-group:

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&IncludeSubGroup=true

For service availability calculation:

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&ServiceAvailability=true

For custom time availability report:

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&CustomTime=true&StartTime=2&EndTime=4

To set the Report Period:

http://localhost:9090/AppManager/json/getMonitorGroupAvailability?apikey=833015a191b75b11f953774ab34f034d&ReportPeriod=1

To filter with Haids:

http://localhost:9092/AppManager/xml/getMonitorGroupAvailabilityInfo?apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true&haid=10000

Sample Output

Description

Sample Inputs and Outputs

To include sub-group

Input:

http://localhost:9092/AppManager/json/getMonitorGroupAvailability?apikey=a593773d172734ed160d7cd6502a23e2&IncludeSubGroup=true

Output:

Today Availability Report

ResourceID,DisplayName,Uptime %,Downtime %

10001368,App2-level1,100%,0%

10001369,App2-level2,100%,0%

10000252,App - 1,0.0%,100.0%