Retrieving the Count of Events from Alarm History
Using the eG REST API, administrators can retrieve the count of events from Alarm History for all component types, components, layers and tests specific to the target environment.
Retrieving the Count of Events from Alarm History for all Component Types
URL: http://<eG manager IP:port>/api/eg/analytics/getEventCount/servertype
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" } |
|
Body |
Default: { "timeline":"Timeline for retrieving the count of events (in hours/days/weeks)" } |
| Type | Code | Content |
|---|---|---|
|
JSON |
200 |
{ "eventCount": [ { "componentType": "Citrix License", "eventCount": "4" }, { "componentType": "eG Manager", "eventCount": "133" }, . . . } |
| Type | Code | Content |
|---|---|---|
|
JSON |
401 UNAUTHORIZED |
{"code": 401,"error": "Invalid username or password"} |
|
JSON |
400 BAD REQUEST |
You may receive one of the following responses: {"code": 400,"error": " Bad Request. Header parameters : Username or Password or Manager Url is missing"} (or) {"code": 400,"error": " Bad Request. Manager Url,Username,password is not provided"} (or) {"code": 400,"error": " Component type not associated with this user"} (or) {"code": 400,"error": "No components associated for this user"} (or) {"code": 400,"error": "Provide a space between value and unit in Timeline"} (or) {"code": 400,"error": "Invalid Timeline. Please refer EG REST API documentation for this API"} |
|
JSON |
500 Server Error |
{"code": 500,"error": " Server Error. Please check /manager/logs/error_log in the installation directory for more information"} |
Figure 1 : Retrieving count of events from Alarm History for all Component Types using Postman REST Client
Retrieving the Count of Events from Alarm History for all Component Types using cURL
To retrieve the count of events for all Component Types using cURL, the command should be specified in the following format:
curl -L -X POST "http://<eG Manager IP:Port>/api/eg/analytics/getEventCount/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 count of events (in hours/days/weeks)\"}"
Figure 2 shows an example of retrieving the count of events recorded for all Components Types using cURL.
Figure 2 : Retrieving count of events from Alarm History for all Component Types using cURL
Retrieving the Count of Events for all Components
URL: http://<eG manager IP:port>/api/eg/analytics/getEventCount/servername
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" } |
|
Body |
Default: { "timeline":"Timeline for retrieving the count of events(in hours/days/weeks)" } |
| Type | Code | Content |
|---|---|---|
|
JSON |
200 |
{ "eventCount": [ { "componentName": "CTXCONNECTSRV", "eventCount": "8" }, { "componentName": "MySQL_Cluster_10.87:3306", "eventCount": "11" }, . . . } |
| Type | Code | Content |
|---|---|---|
|
JSON |
401 UNAUTHORIZED |
{"code": 401,"error": "Invalid username or password"} |
|
JSON |
400 BAD REQUEST |
You may receive one of the following responses: {"code": 400,"error": " Bad Request. Header parameters : Username or Password or Manager Url is missing"} (or) {"code": 400,"error": " Bad Request. Manager Url,Username,password is not provided"} (or) {"code": 400,"error": " Component type not associated with this user"} (or) {"code": 400,"error": "No components associated for this user"} (or) {"code": 400,"error": "Provide a space between value and unit in Timeline"} (or) {"code": 400,"error": "Invalid Timeline. Please refer EG REST API documentation for this API"} |
|
JSON |
500 Server Error |
{"code": 500,"error": " Server Error. Please check /manager/logs/error_log in the installation directory for more information"} |
Figure 3 : Retrieving count of events from Alarm History for all Components using Postman REST Client
Retrieving the Count of Events for all Components using cURL
To retrieve the count of events for all Components using cURL, the command should be specified in the following format:
curl -L -X POST "http://<eG Manager IP:Port>/api/eg/analytics/getEventCount/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 count of events (in hours/days/weeks)\"}"
Figure 2 shows an example of retrieving the count of events from Alarm History for all Components using cURL.
Figure 4 : Retrieving count of events from Alarm History for all Components using cURL
Retrieving the Count of Events from Alarm History specific to Layers of a Component Type
URL: http://<eG manager IP:port>/api/eg/analytics/getEventCount/layer
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":"2 weeks", "componentType":"Microsoft SQL" } |
|
Body |
Default: { "timeline":"Timeline for retrieving the count of events (in hours/days/weeks)", "componentType":"Component Type" } |
| Type | Code | Content |
|---|---|---|
|
JSON |
200 |
{ "eventCount": [ { "layer": "Windows Service", "eventCount": "160" }, { "layer": "TCP", "eventCount": "7" }, . . . } |
| Type | Code | Content |
|---|---|---|
|
JSON |
401 UNAUTHORIZED |
{"code": 401,"error": "Invalid username or password"} |
|
JSON |
400 BAD REQUEST |
You may receive one of the following responses: {"code": 400,"error": " Bad Request. Header parameters : Username or Password or Manager Url is missing"} (or) {"code": 400,"error": " Bad Request. Manager Url,Username,password is not provided"} (or) {"code": 400,"error": " Component type not associated with this user"} (or) {"code": 400,"error": "No components associated for this user"} (or) {"code": 400,"error": "Provide a space between value and unit in Timeline"} (or) {"code": 400,"error": "Invalid Timeline. Please refer EG REST API documentation for this API"} |
|
JSON |
500 Server Error |
{"code": 500,"error": " Server Error. Please check /manager/logs/error_log in the installation directory for more information"} |
Figure 5 : Retrieving count of events from Alarm History for the layers of a component type using Postman REST Client
Retrieving the Count of Events from Alarm History specific to Layers of a Component Type using cURL
To retrieve the count of events that are specific to layers of a component type using cURL, the command should be specified in the following format:
curl -L -X POST "http://<eG Manager IP:Port>/api/eg/analytics/getEventCount/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 count of events (in hours/days/weeks)\",\"componentType\":\"Component Type\"}"
Figure 2 shows an example of retrieving the count of events from Alarm History for the layers of a chosen component type using cURL.
Figure 6 : Retrieving count of events from Alarm History for the layers of a component type using cURL
Retrieving the Count of Events from Alarm History specific to Tests of a Component Type
URL: http://<eG manager IP:port>/api/eg/analytics/getEventCount/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", "componentType":"Microsoft SQL" } |
|
Body |
Default: { "timeline":"Timeline for retrieving the count of events (in hours/days/weeks)", "componentType":"Component Type" } |
| Type | Code | Content |
|---|---|---|
|
JSON |
200 |
{ "eventCount": [ { "test": "Uptime", "eventCount": "2" }, { "test": "TCP Port Status", "eventCount": "32" }, . . . } |
| Type | Code | Content |
|---|---|---|
|
JSON |
401 UNAUTHORIZED |
{"code": 401,"error": "Invalid username or password"} |
|
JSON |
400 BAD REQUEST |
You may receive one of the following responses: {"code": 400,"error": " Bad Request. Header parameters : Username or Password or Manager Url is missing"} (or) {"code": 400,"error": " Bad Request. Manager Url,Username,password is not provided"} (or) {"code": 400,"error": " Component type not associated with this user"} (or) {"code": 400,"error": "No components associated for this user"} (or) {"code": 400,"error": "Provide a space between value and unit in Timeline"} (or) {"code": 400,"error": "Invalid Timeline. Please refer EG REST API documentation for this API"} |
|
JSON |
500 Server Error |
{"code": 500,"error": " Server Error. Please check /manager/logs/error_log in the installation directory for more information"} |
Figure 7 : Retrieving count of events from Alarm History for the tests of a component type using Postman REST Client
Retrieving the Count of Events from Alarm History specific to Tests of a Component Type using cURL
To retrieve the count of events from Alarm History that are specific to tests of a component type using cURL, the command should be specified in the following format:
curl -L -X POST "http://<eG Manager IP:Port>/api/eg/analytics/getEventCount/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 count of events (in hours/days/weeks)\",\"componentType\":\"Component Type\"}"
Figure 2 shows an example of retrieving the count of events from Alarm History for the tests of a chosen component type using cURL.
Figure 8 : Retrieving count of events from Alarm History for the tests of a component type using cURL
