Since Product Version: 3.1
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
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/metricsRequest Parameters
Attribute | Source | Description |
---|---|---|
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 URLs 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. |
Response Parameters
Attribute | Description |
---|---|
info String |
Metrics info |
Metric details list |
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?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?device=192.168.0.1&amp;ifName=GigabitEthernet0/1&amp;timeInterval=1
" rootUrl="https://localhost/webacs/api/v2/op">
<metricsDTO>
<info>String value</info>
<metrics>
<metrics>
<description>String value</description>
<name>String value</name>
<type>TIME_SERIES</type>
<units>
<units>NUMBER</units>
</units>
<url>String value</url>
</metrics>
</metrics>
</metricsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/statisticsService/interfaces/metrics.json?device=192.168.0.1&ifName=GigabitEthernet0/1&timeInterval=1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/statisticsService/interfaces/metrics?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",
"metricsDTO" : [ {
"info" : "String value",
"metrics" : {
"metrics" : [ {
"description" : "String value",
"name" : "String value",
"type" : "TIME_SERIES",
"units" : {
"units" : [ "NUMBER" ]
},
"url" : "String value"
} ]
}
} ]
}
}