Retrieving Problem Duration
Using the eG REST API, administrators can retrieve the duration for which an alarm was open for all component types or components or layers specific to the component type or tests specific to a component type.
Retrieving Problem Duration for Component Types
URL: http://<eG manager IP:port>/api/eg/analytics/getProblemDuration/servertype
Method: POST
Content-Type: application/json
Parameters | Key values | Example |
---|---|---|
Headers |
managerurl user pwd |
{ "timeline":"1 hour" } |
Body |
Default: { "timeline":"Timeline for retrieving the alarm duration (in hours/days/weeks)" } |
Type | Code | Content |
---|---|---|
JSON |
200 |
{ "Problem Duration": [ { "ServerType": "Java Application", "MIN_DURATION": "4m 7s", "MAX_DURATION": "8h 4m", "AVG_DURATION": "18m 23s" }, . . . } |
Type | Code | Content |
---|---|---|
JSON |
401 UNAUTHORIZED |
{"code": 401,"error": "Unauthorized user"} |
JSON |
500 Server Error |
{"code": 500,"error": " Server Error "} |
Figure 1 : Retrieving the duration for which an alarm was open for all Component Types using Postman REST Client
Retrieving Problem Duration for all Component Types using cURL
To retrieve the duration for which an alarm was open for the 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/getProblemDuration/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 alarm duration(in hours/days/weeks)\"}"
Figure 2 shows an example of retrieving the duration for which an alarm was open for the component types managed in the target environment using cURL.
Figure 2 : Retrieving the duration for which an alarm was open for all Component Types using cURL
Retrieving Problem Duration for all Components
URL: http://<eG manager IP:port>/api/eg/analytics/getProblemDuration/servername
Method: POST
Content-Type: application/json
Parameters | Key values | Example |
---|---|---|
Headers |
managerurl user pwd |
{ "timeline":"1 hour" } |
Body |
Default: { "timeline":"Timeline for retrieving the alarms (in hours/days/weeks)" } |
Type | Code | Content |
---|---|---|
JSON |
200 |
{ "Problem Duration": [ { "Server Name": "esx51-15", "MIN_DURATION": "0s", "MAX_DURATION": "4D 1h", "AVG_DURATION": "19h 21m" }, . . . } |
Type | Code | Content |
---|---|---|
JSON |
401 UNAUTHORIZED |
{"code": 401,"error": "Unauthorized user"} |
JSON |
500 Server Error |
{"code": 500,"error": " Server Error "} |
Figure 3 : Retrieving the duration for which an alarm was open for all Components using Postman REST Client
Retrieving Problem Duration for all Components using cURL
To retrieve the duration for which an alarm was open 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/getProblemDuration/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 alarm duration(in hours/days/weeks)\"}"
Figure 2 shows an example of retrieving the duration for which an alarm was open for all components managed in the target environment using cURL.
Figure 4 : Retrieving the duration for which an alarm was open for all Components using cURL
Retrieving Problem Duration for all Layers of a Component Type
URL: http://<eG manager IP:port>/api/eg/analytics/getProblemDuration/layer
Method: POST
Content-Type: application/json
Parameters | Key values | Example |
---|---|---|
Headers |
managerurl user pwd |
{ "timeline":"1 hour", "servertype":Microsoft Windows" } |
Body |
Default: { "timeline":"Timeline for retrieving the alarms (in hours/days/weeks)", "servertype":"Component Type" } |
Type | Code | Content |
---|---|---|
JSON |
200 |
{ "Problem Duration": [ { "Layer Name": "Operating System", "MIN_DURATION": "24m 36s", "MAX_DURATION": "24m 36s", "AVG_DURATION": "24m 36s" }, . . . } |
Type | Code | Content |
---|---|---|
JSON |
401 UNAUTHORIZED |
{"code": 401,"error": "Unauthorized user"} |
JSON |
500 Server Error |
{"code": 500,"error": " Server Error "} |
Figure 5 : Retrieving the duration for which an alarm was open for all layers of a Component types using Postman REST Client
Retrieving Problem Duration for all Layers of a Component Type using cURL
To retrieve the duration for which an alarm was open for all layers of a 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/getProblemDuration/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 alarm duration(in hours/days/weeks)\",\"servertype\":\"Component Type\"}"
Figure 2 shows an example of retrieving the duration for which an alarm was open for all layers corresponding to a component type managed in the target environment using cURL.
Figure 6 : Retrieving the duration for which an alarm was open for all layers of a Component types using cURL
Retrieving Problem Duration for all Tests of a Component Type
URL: http://<eG manager IP:port>/api/eg/analytics/getProblemDuration/test
Method: POST
Content-Type: application/json
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" } |
Type | Code | Content |
---|---|---|
JSON |
200 |
{ "Problem Duration": [ { "Test Name": "Uptime", "MIN_DURATION": "4m 11s", "MAX_DURATION": "5m 6s", "AVG_DURATION": "4m 38s" }, . . . } |
Type | Code | Content |
---|---|---|
JSON |
401 UNAUTHORIZED |
{"code": 401,"error": "Unauthorized user"} |
JSON |
500 Server Error |
{"code": 500,"error": " Server Error "} |
Figure 7 : Retrieving the duration for which an alarm was open for all Tests of a Component Type using Postman REST Client
Retrieving Problem Duration for all Tests of a Component Type using cURL
To retrieve the duration for which an alarm was open for all tests of a 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/getProblemDuration/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 alarm duration(in hours/days/weeks)\",\"servertype\":\"Component Type\"}"
Figure 2 shows an example of retrieving the duration for which an alarm was open for all tests of a component type managed in the target environment using cURL.
Figure 8 : Retrieving the duration for which an alarm was open for all Tests of a Component Type using cURL