|
| void | get (out TrafficStatisticList list, out long totalItems, in kerio::web::SearchQuery query, in boolean refresh) |
| |
| void | remove (in kerio::web::KIdList ids) |
| |
| void | getHistogram (out Histogram hist, in kerio::web::HistogramType type, in kerio::web::KId id) |
| |
| void | getHistogramInc (out Histogram hist, out kerio::web::DateTimeStamp sampleTime, in kerio::web::HistogramIntervalType type, in kerio::web::KId id, in kerio::web::DateTimeStamp startSampleTime) |
| |
| void webadmin::TrafficStatistics::get |
( |
out TrafficStatisticList |
list, |
|
|
out long |
totalItems, |
|
|
in kerio::web::SearchQuery |
query, |
|
|
in boolean |
refresh |
|
) |
| |
Returns Rule Statistics data
- Parameters
-
| list | - output data |
| totalItems | - all data count |
| query | - filter/sort query |
| refresh | - true in case, that data snapshot have to be refreshed |
- Exceptions
-
| kerio::web::ApiException |
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::TrafficStatistics::getHistogram |
( |
out Histogram |
hist, |
|
|
in kerio::web::HistogramType |
type, |
|
|
in kerio::web::KId |
id |
|
) |
| |
Returns throughput Histogram for specified rule or interface
- Parameters
-
| hist | - output data |
| type | - granularity (two hours or one day) |
| id | - rule or interface id returned in item.id member by get |
- Exceptions
-
| kerio::web::ApiException |
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::TrafficStatistics::getHistogramInc |
( |
out Histogram |
hist, |
|
|
out kerio::web::DateTimeStamp |
sampleTime, |
|
|
in kerio::web::HistogramIntervalType |
type, |
|
|
in kerio::web::KId |
id, |
|
|
in kerio::web::DateTimeStamp |
startSampleTime |
|
) |
| |
Returns throughput Histogram for specified rule or interface
- Parameters
-
| hist | - output data |
| sampleTime | - Returns first time, that is not included in returned data (pass it to the same method again as a lastSampleTime to obtain only new data since last request) |
| startSampleTime | - Specifies starting time for returned d |
| type | - granularity |
| id | - rule or interface id returned in item.id member by get |
- Exceptions
-
| kerio::web::ApiException |
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::TrafficStatistics::remove |
( |
in kerio::web::KIdList |
ids | ) |
|
Deletes rule traffic counters
- Parameters
-
| ids | - Ids of statistics items to be removed. |
- Exceptions
-
| kerio::web::ApiException |
-32001 Session expired. - "The user is not logged in."
1004 Access denied. - "Insufficient rights to perform the requested operation." |
The documentation for this interface was generated from the following file:
