Retrieving Threshold Data

Using the eG REST API, administrators can retrieve the threshold configured for the measures of a chosen test. The table below specifies the URL and the parameters that should be used to retrieve the measures of the tests.

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

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

{

"test":"Oracle Latches",

"host":"Oracle",

"port":"1521",

"info":"egurkha+redo allocation",

"type":"Threshold"

}

Body

Default:

{

"test":"Test name",

"host":"Host name",

"port":"Port",

"info":"info"

}

Optional:

"type":"Threshold",

"measure":"comma-separated list of measures",

"searchhost":"Search Host",

"searchinfo":"Search info",

"groupby":"TRGT_HOST",

"orderby":"Ascending/Descending",

}

 

Success Response
Type Code Content

JSON

200

[

"TRGT_HOST PORT_NO SITE_NAME INFO MSMT_HOST MSMT_TIME_START MSMT_TIME_END TOTAL_CAPACITY_MIN TOTAL_CAPACITY_MAX USED_SPACE_MIN USED_SPACE_MAX FREE_SPACE_MIN FREE_SPACE_MAX PERCENT_USAGE_MIN PERCENT_USAGE_MAX DRIVE_AVAIL_MIN DRIVE_AVAIL_MAX ",

"",

"win183 NULL NULL +D win183 2020-09-12 19:30:00 2020-09-12 20:30:00 -1 -1 -1 -1 -1 -1 -1 99/97/95 -/-/90 -1",

"win183 NULL NULL +D win183 2020-09-12 20:30:00 2020-09-12 21:30:00 -1 -1 -1 -1 -1 -1 -1 99/97/95 -/-/90 -1",

"win183 NULL NULL +D win183 2020-09-12 21:30:00 2020-09-12 22:30:00 -1 -1 -1 -1 -1 -1 -1 99/97/95 -/-/90 -1",

"win183 NULL NULL +D win183 2020-09-12 22:30:00 2020-09-12 23:30:00 -1 -1 -1 -1 -1 -1 -1 99/97/95 -/-/90 -1",

"win183 NULL NULL +D win183 2020-09-12 23:30:00 2020-09-13 00:30:00 -1 -1 -1 -1 -1 -1 -1 99/97/95 -/-/90 -1",

.

.

.

]

 

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 Threshold data configured for the measures using Postman REST Client

Retrieving Threshold Data using cURL

To retrieve the threshold configured for the measures of a chosen test using cURL, the command should be specified in the following format:

curl -location -request POST "http://<eG Manager IP:Port>/api/eg/analytics/getThresholdData" -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 "{\"test\":\"Test name\",\"host\":\"Host name\",\"type\":\"Threshold\"}"

Figure 2 shows an example to retrieve the threshold configured for the measures of a chosen test using cURL.

Figure 2 : An example cURL command to retrieve the threshold configured for the measures

Figure 3 shows a sample output that retrieves the threshold configured for the measures of a chosen test reported by eG Enterprise using cURL.

Figure 3 : Sample output with the threshold data configured for the measures of a chosen test