Retrieving Problem Distribution of the Target Environment

Using the eG REST API, administrators can retrieve the alarm count based on severity for all component types, components, layers and tests specific to the target environment.

Retrieving Problem Distribution for all Component Types

URL: http://<eG manager IP:port>/api/eg/analytics/getProblemDistribution/servertype

Method: POST

Content-Type: application/json

Inputs to be Specified
Parameters Key values Example

Headers

managerurl

user

pwd

{

"timeline":"1 hour"

}

Body

Default:

{

"timeline":"Timeline for retrieving the alarms (in hours/days/weeks)"

}

 

Success Response
Type Code Content

JSON

200

{

"Problem Distribution": [

{

"Server Type": "Java Application",

"CRITICAL": "0",

"MAJOR": "47",

"MINOR": "7"

},

.

.

.

}

 

Failure Response
Type Code Content

JSON

401 UNAUTHORIZED

{"code": 401,"error": "Unauthorized user"}

JSON

500 Server Error

{"code": 500,"error": " Server Error "}

Figure 1 : Retrieving the alarm count based on severity for all component types using Postman REST Client

Retrieving Problem Distribution for all Component Types using cURL

To retrieve the alarm count based on severity for all component types managed in the target environment using cURL, the command should be specified in the following format:

curl -location -request POST "http://<eG Manager IP:Port>/api/eg/analytics/getProblemDistribution/servertype" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "managerurl:http://<eG Manager IP:Port>" -H"Content-Type:application/json" --data-raw "{\"timeline\":\"Timeline for retrieving the alarms (in hours/days/weeks)\"}"

Figure 2 shows an example to retrieve the alarm count based on severity for all component types managed in the target environment using cURL.

Figure 2 : Retrieving the alarm count based on severity for all component types using cURL

Retrieving Problem Distribution for all Components

URL: http://<eG manager IP:port>/api/eg/analytics/getProblemDistribution/servername

Method: POST

Content-Type: application/json

Inputs to be Specified
Parameters Key values Example

Header

managerurl: Base URL of the eG Manager i.e., http://<IP address of the eG console:Port>

user: eG username or domain/eG username

pwd: Base64 encoded password

{

"timeline":"1 hour"

}

Body

Default:

{

"timeline":"Timeline for retrieving the alarms (in hours/days/weeks)"

}

 

Success Response
Type Code Content

JSON

200

{

"Problem Distribution": [

{

"Server Name": "esx51-15",

"CRITICAL": "11",

"MAJOR": "26",

"MINOR": "148"

},

{

"Server Name": "win183",

"CRITICAL": "5",

"MAJOR": "6",

"MINOR": "1"

},

.

.

.

}

 

Failure Response
Type Code Content

JSON

401 UNAUTHORIZED

{"code": 401,"error": "Unauthorized user"}

JSON

500 Server Error

{"code": 500,"error": " Server Error "}

Figure 3 : Retrieving the alarm count based on severity for all components using Postman REST Client

Retrieving Problem Distribution for all Components using cURL

To retrieve the alarm count based on severity for all components managed in the target environment using cURL, the command should be specified in the following format:

curl -location -request POST "http://<eG Manager IP:Port>/api/eg/analytics/getProblemDistribution/servername" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "managerurl:http://<eG Manager IP:Port>" -H"Content-Type:application/json" --data-raw "{\"timeline\":\"Timeline for retrieving the alarms (in hours/days/weeks)\"}"

Figure 2 shows an example to retrieve the alarm count based on severity for all components managed in the target environment using cURL.

Figure 4 : Retrieving the alarm count based on severity for all components using cURL

Retrieving Problem Distribution of the Layers of a Component Type

URL: http://<eG manager IP:port>/api/eg/analytics/getProblemDistribution/layer

Method: POST

Content-Type: application/json

Inputs to be Specified
Parameters Key values Example

Headers

managerurl: Base URL of the eG Manager i.e., http://<IP address of the eG console:Port>

user: eG username or domain/eG username

pwd: Base64 encoded password

{

"timeline":"1 hour",

"servertype":"Microsoft Windows"

}

Body

Default:

{

"timeline":"Timeline for retrieving the alarms (in hours/days/weeks)",

"servertype":"Component Type"

}

 

Success Response
Type Code Content

JSON

200

{

"Problem Distribution": [

{

"Layer Name": "Application Processes",

"CRITICAL": "4",

"MAJOR": "3",

"MINOR": "0"

},

.

.

.

}

 

Failure Response
Type Code Content

JSON

401 UNAUTHORIZED

{"code": 401,"error": "Unauthorized user"}

JSON

500 Server Error

{"code": 500,"error": " Server Error "}

Figure 5 : Retrieving the alarm count based on severity for all layers of a Component Type using Postman REST Client

Retrieving Problem Distribution of the Layers of a Component Type using cURL

To retrieve the alarm count based on severity corresponding to all layers of a chosen Component Type managed in the target environment using cURL, the command should be specified in the following format:

curl -location -request POST "http://<eG Manager IP:Port>/api/eg/analytics/getProblemDistribution/layer" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "managerurl:http://<eG Manager IP:Port>" -H"Content-Type:application/json" --data-raw "{\"timeline\":\"Timeline for retrieving the alarms (in hours/days/weeks)\",\"servertype\":\"Component Type\"}"}"

Figure 2 shows an example to retrieve the alarm count based on severity corresponding to all layers of a chosen Component Type managed in the target environment using cURL.

Figure 6 : Retrieving the alarm count based on severity for all layers of a Component Type using cURL

Retrieving Problem Distribution of the Tests of a Component Type

URL: http://<eG manager IP:port>/api/eg/analytics/getProblemDistribution/test

Method: POST

Content-Type: application/json

Inputs to be Specified
Parameters Key values Example

Headers

managerurl: Base URL of the eG Manager i.e., http://<IP address of the eG console:Port>

user: eG username or domain/eG username

pwd: Base64 encoded password

{

"timeline":"1 hour",

"servertype":"Microsoft Windows"

}

Body

Default:

{

"timeline":"Timeline for retrieving the alarms (in hours/days/weeks)",

"servertype":"Component Type"

}

 

Success Response
Type Code Content

JSON

200

{

"Problem Distribution": [

{

"Test Name": "Windows Services",

"CRITICAL": "5",

"MAJOR": "0",

"MINOR": "0"

},

.

.

.

}

 

Failure Response
Type Code Content

JSON

401 UNAUTHORIZED

{"code": 401,"error": "Unauthorized user"}

JSON

500 Server Error

{"code": 500,"error": " Server Error "}

Figure 7 : Retrieving the alarm count based on severity for all tests of a Component Type using Postman REST Client

Retrieving Problem Distribution of the Tests of a Component Type using cURL

To retrieve the alarm count based on severity for the tests of a chosen Component Type managed in the target environment using cURL, the command should be specified in the following format:

curl -location -request POST "http://<eG Manager IP:Port>/api/eg/analytics/getProblemDistribution/test" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "managerurl:http://<eG Manager IP:Port>" -H"Content-Type:application/json" --data-raw "{\"timeline\":\"Timeline for retrieving the alarms (in hours/days/weeks)\",\"servertype\":\"Component Type\"}"}"

Figure 2 shows an example to retrieve the alarm count based on severity for all tests of a chosen Component Type managed in the target environment using cURL.

Figure 8 : Retrieving the alarm count based on severity for all tests of a Component Type using cURL