Since Product Version: 1.2
Resource URL
/webacs/api/v1/op/statisticsService/device/portSummaryRequest Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
ipAddress required |
query |
The IP Address of the device. |
String |
type optional |
query |
An filter parameter with possible values: SUMMARY (to return a summary of count of ports that are Up, Administratively down or Operationally down), or ALARMSEVERITY (to return the minimum Alarm severity of all the down ports). By default, if this parameter not provided, it returns the status summary of the ports. |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
childStatistics |
The set of nested StatisticsDTO objects. |
|
statisticEntry |
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics. |
|
StatisticsOperationTypeEnum |
statisticsName |
The Statistics operation type. Allowed 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://172.25.123.114/webacs/api/v1/op/statisticsService/device/portSummary?ipAddress="192.168.0.1"
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsService/device/portSummary?ipAddress=&quot;192.168.0.1&quot;" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <statisticsDTO> <childStatistics> <childStatistic> <childStatistics> <childStatistic> <childStatistics> <childStatistic> <statisticEntries> <statisticEntry> <attributeName>String value</attributeName> <displayName>String value</displayName> <entryValue>String value</entryValue> </statisticEntry> </statisticEntries> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </childStatistic> </childStatistics> <statisticEntries> <statisticEntry> <attributeName>String value</attributeName> <displayName>String value</displayName> <entryValue>String value</entryValue> </statisticEntry> </statisticEntries> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </childStatistic> </childStatistics> <statisticEntries> <statisticEntry> <attributeName>String value</attributeName> <displayName>String value</displayName> <entryValue>String value</entryValue> </statisticEntry> </statisticEntries> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </childStatistic> </childStatistics> <statisticEntries> <statisticEntry> <attributeName>String value</attributeName> <displayName>String value</displayName> <entryValue>String value</entryValue> </statisticEntry> </statisticEntries> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </statisticsDTO> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/statisticsService/device/portSummary.json?ipAddress="192.168.0.1"
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/device\/portSummary?ipAddress="192.168.0.1"", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "statisticsDTO" : { "childStatistics" : { "childStatistic" : { "childStatistics" : { "childStatistic" : { "childStatistics" : { "childStatistic" : { "statisticEntries" : { "statisticEntry" : { "attributeName" : "String value", "displayName" : "String value", "entryValue" : "String value" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticEntries" : { "statisticEntry" : { "attributeName" : "String value", "displayName" : "String value", "entryValue" : "String value" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticEntries" : { "statisticEntry" : { "attributeName" : "String value", "displayName" : "String value", "entryValue" : "String value" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticEntries" : { "statisticEntry" : { "attributeName" : "String value", "displayName" : "String value", "entryValue" : "String value" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } } }