Since Product Version: 1.2
Resource URL
/webacs/api/v1/op/statisticsService/device/availabilityRequest Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
ipAddress required |
query |
The IP Address of the required device. |
Integer |
range required |
query |
Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters. |
Long |
startTime required |
query |
Represents the start time of a time period in seconds. (See 'range' for more details) |
Long |
endTime required |
query |
Represents the end time of a time period in seconds. (See 'range' for more details) |
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://192.168.115.187/webacs/api/v1/op/statisticsService/device/availability?range=1&ipAddress="192.168.0.1"
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <mgmtResponse rootUrl="https://192.168.115.187/webacs/api/v1/op/" requestUrl="https://192.168.115.187/webacs/api/v1/op/statisticsService/device/availability?range=1&ipAddress="192.168.0.1" " responseType="operation"> <statisticsDTO> <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> <statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName> </statisticsDTO> </mgmtResponse>
Sample JSON Response Payload
https://192.168.115.187/webacs/api/v1/op/statisticsService/device/availability?range=1&ipAddress="192.168.0.1" .json
{ "mgmtResponse" : { "@rootUrl" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/op\/", "@requestUrl" : "https : \/\/192.168.115.187\/webacs\/api\/v1\/op\/statisticsService\/device\/availability?range=1&ipAddress=\"192.168.0.1\"\n\t\t\t\t\t", "@responseType" : "operation", "statisticsDTO" : { "childStatistics" : { "childStatistic" : { "childStatistics" : { "childStatistic" : { "childStatistics" : { "childStatistic" : { "childStatistics" : { "childStatistic" : { "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } }, "statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION" } } }