Fetches the metric data for an Interface
Additional metric request parameters:-
isFullHierarchy — Specifies full or short class hierarchy. Default is false.
qosclassmap -
direction — 1 - input, 2 - output
(default).
qosclassmap, qosclassmaptoptrend -
qosRateField — One of dropPolicyToggle
(default), prePolicyToggle, postPolicyToggle.
qosclassmaptoptrend -
trafficDirection — One of ALL
(default), IN, OUT.
topnapplication, topapplicationtrafficovertime -
sortOrder — One of DESC
(default), ASC.
topnapplication, topapplicationtrafficovertime -
networkAwareType — Network aware. Wireless: 1, Wired: 2, All: -1
(default).
topnapplication, topapplicationtrafficovertime -
appId — Comma separated application IDs. Default is 0 (all applications).
topnapplication, topapplicationtrafficovertime -
siteId — Site ID. Default is 0 (all sites).
topnapplication, topapplicationtrafficovertime -
dataType — One of rate
(default), volume.
topnapplication, topapplicationtrafficovertime -
dscp — DSCP.
topnapplication - metricDataType — One of TOP_N, TIME_SERIES. Current metric's default data type is used if this parameter is not set.
Since Product Version: 3.1
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}Request Parameters
Attribute | Source | Description |
---|---|---|
metric String |
path |
RequiredThe metric name for which the data need to be fetched. |
device String |
query |
RequiredThe IP address of the device to which the interface belongs. |
ifName String |
query |
RequiredName of the interface for which the metric data need to be fetched. |
timeInterval Integer |
query |
OptionalSpecifies the range of time (in hours). This field can contain values like 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. By default is 1 hour if neither timeInterval parameter nor the parameters startTime and endTime not provided. |
startTime Long |
query |
OptionalSpecifies the start time in seconds. The timeInterval parameter overrides this parameter. |
endTime Long |
query |
OptionalSpecifies the end time in seconds. The timeInterval parameter overrides this parameter. |
isFullHierarchy Boolean |
query |
OptionalSpecifies full or short class hierarchy which is needed. Used in QOS Class Map and QOS Class Map Top Trend metrics. Default is false. |
direction Integer |
query |
OptionalDirection (1 - input, 2 - output). Used in QOS Class Map Top Trend metric. Default is 2. |
qosRateField String |
query |
OptionalOne of dropPolicyToggle, prePolicyToggle, postPolicyToggle. Used in QOS Class Map Top Trend metric. Default is dropPolicyToggle. |
trafficDirection String |
query |
OptionalOne of ALL, IN, OUT. Used in Top N Application and Top Application Traffic Overtime metrics. Default is ALL. |
sortOrder String |
query |
OptionalOne of DESC, ASC. Used in Top N Application and Top Application Traffic Overtime metrics. Default is DESC. |
networkAwareType String |
query |
OptionalNetwork aware. Wireless: 1, Wired: 2, All: -1. Used in Top N Application and Top Application Traffic Overtime metrics. Default is -1. |
appId String |
query |
OptionalComma separated application IDs. Used in Top N Application and Top Application Traffic Overtime metrics. Default is 0 (all applications). |
siteId String |
query |
OptionalSite ID. Used in Top N Application and Top Application Traffic Overtime metrics. Default is 0 (all sites). |
dataType String |
query |
OptionalOne of rate, volume. Used in Top N Application and Top Application Traffic Overtime metrics. Default is rate. |
dscp String |
query |
OptionalDSCP. Used in Top N Application metric. |
metricDataType String |
query |
OptionalOne of TOP_N, TIME_SERIES. Current metric's default data type is used if this parameter is not set. |
firstResult Integer |
header |
OptionalDefines the offset from the first result you want to fetch. Default is 0. |
maxResults Integer |
header |
OptionalDefines maximum amount of hits to be returned. Default is 20. |
Response Parameters
Attribute | Description |
---|---|
currentDateTime String |
Current timestamp |
description String |
Metric description |
metricName String |
Metric name |
Metric data list |
|
resourceName String |
Resource name |
Properties of X values |
|
Properties of Y values |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}?device=192.168.0.1&ifName=GigabitEthernet0/1&timeInterval=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}?device=192.168.0.1&amp;ifName=GigabitEthernet0/1&amp;timeInterval=1
" rootUrl="https://localhost/webacs/api/v2/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<YValues>
<YValues>15.0</YValues>
</YValues>
</metricRows>
</metricRows>
<resourceName>String value</resourceName>
<XValueProperty>
<label>String value</label>
<unit>NUMBER</unit>
</XValueProperty>
<YValueProperty>
<YValueProperty>
<label>String value</label>
<maxVal>4.0</maxVal>
<minVal>4.0</minVal>
<unit>NUMBER</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}.json?device=192.168.0.1&ifName=GigabitEthernet0/1&timeInterval=1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/statisticsService/interfaces/metrics/{metric}?device=192.168.0.1&ifName=GigabitEthernet0/1&timeInterval=1\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YValues" : {
"yvalues" : [ 15.0 ]
},
"issue" : "String value"
} ]
},
"resourceName" : "String value"
} ]
}
}