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/interfacesRequest Parameters
Attribute | Source | Description |
---|---|---|
device String |
query |
RequiredThe IP address or name of the device to which the interface belongs. |
ifName String |
query |
OptionalThe interface name whose details need to be fetched. |
firstResult Integer |
query |
OptionalDefines the offset from the first result you want to fetch. Default is 0. |
maxResults Integer |
query |
OptionalDefines maximum amount of hits to be returned. Default is 20. |
sort String |
query |
OptionalComma-separated list of attribute names with their respective order. |
Response Parameters
Attribute | Description |
---|---|
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?device=192.168.0.1&ifName=GigabitEthernet0/1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/statisticsService/interfaces?device=192.168.0.1&amp;ifName=GigabitEthernet0/1
" rootUrl="https://localhost/webacs/api/v2/op">
<resourcesDTO>
<resources>
<resources>
<childrenLink>String value</childrenLink>
<description>String value</description>
<details>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>String value</metricsLink>
<name>String value</name>
<type>String value</type>
</resources>
</resources>
</resourcesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/statisticsService/interfaces.json?device=192.168.0.1&ifName=GigabitEthernet0/1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/statisticsService/interfaces?device=192.168.0.1&ifName=GigabitEthernet0/1\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"resourcesDTO" : [ {
"resources" : {
"resources" : [ {
"childrenLink" : "String value",
"description" : "String value",
"details" : [ {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "String value",
"name" : "String value",
"type" : "String value"
} ]
}
} ]
}
}