Fetches UCI Reachable Devices
Since Product Version: 3.1
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/device-rest/UciDeviceReachability/{groupId}/{startTime}/{endTime}/{maxrecords}
Request Parameters
startTime
Long
|
path
|
RequiredSpecifies the start time in seconds to check the UCI device reachable details from.
|
endTime
Long
|
path
|
RequiredSpecifies the start time in seconds to check the UCI device reachable details to.
|
groupId
String
|
path
|
RequiredSpecifies the group id to get the UCI device reachable details from specified group.
|
maxrecords
Integer
|
path
|
RequiredSpecifies the nubmer of records to fetch
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
APPLICATION_VOLUME
APPLICATION_ART_ANALYSIS
APPLICATION_TOPN_TRAFFICS
APPLICATION_TOPN_WITH_SITES
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
APPLICATION_VOLUME
APPLICATION_ART_ANALYSIS
APPLICATION_TOPN_TRAFFICS
APPLICATION_TOPN_WITH_SITES
|
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/v1/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5" rootUrl="https://localhost/webacs/api/v1/op">
<statisticsDTO>
<childStatistics></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://localhost/webacs/api/v1/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/device-rest\/UciDeviceReachability\/84167\/1463999256\/1465208856\/5",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"statisticsDTO" : {
"childStatistics" : "",
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/device-rest/UciDeviceReachability/{groupId}/{startTime}/{endTime}/{maxrecords}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
path
|
RequiredSpecifies the start time in seconds to check the UCI device reachable details from.
|
endTime
Long
|
path
|
RequiredSpecifies the start time in seconds to check the UCI device reachable details to.
|
groupId
String
|
path
|
RequiredSpecifies the group id to get the UCI device reachable details from specified group.
|
maxrecords
Integer
|
path
|
RequiredSpecifies the nubmer of records to fetch
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
APPLICATION_VOLUME
APPLICATION_ART_ANALYSIS
APPLICATION_TOPN_TRAFFICS
APPLICATION_TOPN_WITH_SITES
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
APPLICATION_VOLUME
APPLICATION_ART_ANALYSIS
APPLICATION_TOPN_TRAFFICS
APPLICATION_TOPN_WITH_SITES
|
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/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5" rootUrl="https://localhost/webacs/api/v2/op">
<statisticsDTO>
<childStatistics></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://localhost/webacs/api/v2/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/device-rest/UciDeviceReachability/{groupId}/{startTime}/{endTime}/{maxrecords}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
path
|
RequiredSpecifies the start time in seconds to check the UCI device reachable details from.
|
endTime
Long
|
path
|
RequiredSpecifies the start time in seconds to check the UCI device reachable details to.
|
groupId
String
|
path
|
RequiredSpecifies the group id to get the UCI device reachable details from specified group.
|
maxrecords
Integer
|
path
|
RequiredSpecifies the nubmer of records to fetch
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
APPLICATION_VOLUME
APPLICATION_ART_ANALYSIS
APPLICATION_TOPN_TRAFFICS
APPLICATION_TOPN_WITH_SITES
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
APPLICATION_VOLUME
APPLICATION_ART_ANALYSIS
APPLICATION_TOPN_TRAFFICS
APPLICATION_TOPN_WITH_SITES
|
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/v3/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5" rootUrl="https://localhost/webacs/api/v3/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_MEMORY_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}, {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_MEMORY_UTILIZATION"
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/op/device-rest/UciDeviceReachability/{groupId}/{startTime}/{endTime}/{maxrecords}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
path
|
RequiredSpecifies the start time in seconds to check the UCI device reachable details from.
|
endTime
Long
|
path
|
RequiredSpecifies the start time in seconds to check the UCI device reachable details to.
|
groupId
String
|
path
|
RequiredSpecifies the group id to get the UCI device reachable details from specified group.
|
maxrecords
Integer
|
path
|
RequiredSpecifies the nubmer of records to fetch
|
Response Parameters
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
childStatistics
StatisticsDTO[]
|
The set of nested StatisticsDTO objects.
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
APPLICATION_VOLUME
APPLICATION_ART_ANALYSIS
APPLICATION_TOPN_TRAFFICS
APPLICATION_TOPN_WITH_SITES
|
|
statisticEntry
StatisticsEntry[]
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics.
|
attributeName
String
|
The name of the attribute.
|
displayName
String
|
The display name of the attribute.
|
entryValue
String
|
|
|
statisticsName
StatisticsOperationTypeEnum
|
The Statistics operation type.
Allowed values:
DEVICE_TOPN_CPU_UTILIZATION
DEVICE_TOPN_MEMORY_UTILIZATION
DEVICE_TOPN_TEMPERATURE
DEVICE_AVAILABILITY
DEVICE_AVAILABILITY_SUMMARY
DEVICE_CPU_UTILIZATION_TREND
DEVICE_MEMORY_UTILIZATION_TREND
DEVICE_HEALTH_INFO
DEVICE_REACHABILITY_STATUS
DEVICE_PORT_SUMMARY
DEVICE_AVAILABILITY_MESSAGE
DEVICE_DOWN_MESSAGE
DEVICE_CPU_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY
INTERFACE_DETAILS
INTERFACE_OUT_ERRORS
INTERFACE_DISCARDS
INTERFACE_UTILIZATION
INTERFACE_TOPN_UTILIZATION
INTERFACE_TOPN_ERRORS
INTERFACE_TOPN_WAN_UTILIZATION
INTERFACE_UTILIZATION_SUMMARY
INTERFACE_AVAILABILITY_SUMMARY
INTERFACE_STATUS_SUMMARY
INTERFACE_AVAILABILITY_MESSAGE
INTERFACE_DOWN_MESSAGE
INTERFACE_TOPN_WAN_ISSUES
INTERFACE_CLASSMAP_QOS
APPLICATION_TOPN_WORST_HOSTS
APPLICATION_TOPN_WORST_SITES
APPLICATION_TOPN_HOSTS
APPLICATION_TOPN_APP_PERFORMANCE
APPLICATION_TOPN_TRAFFIC_ANALYSIS
APPLICATION_NUMBER_OF_USERS
SYSTEM_INFO
SYSTEM_HEALTH
APPLICATION_VOLUME
APPLICATION_ART_ANALYSIS
APPLICATION_TOPN_TRAFFICS
APPLICATION_TOPN_WITH_SITES
|
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/v4/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5" rootUrl="https://localhost/webacs/api/v4/op">
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_CPU_UTILIZATION</statisticsName>
</statisticsDTO>
<statisticsDTO>
<childStatistics></childStatistics>
<statisticEntries>
<statisticEntry>
<attributeName>String value</attributeName>
<displayName>String value</displayName>
<entryValue>String value</entryValue>
</statisticEntry>
<statisticEntry>
<attributeName>Another string value</attributeName>
<displayName>Another string value</displayName>
<entryValue>Another string value</entryValue>
</statisticEntry>
</statisticEntries>
<statisticsName>DEVICE_TOPN_MEMORY_UTILIZATION</statisticsName>
</statisticsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/device-rest/UciDeviceReachability/84167/1463999256/1465208856/5",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"statisticsDTO" : [ {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}, {
"childStatistics" : {
"childStatistic" : [ ]
},
"statisticEntries" : {
"statisticEntry" : [ {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}, {
"attributeName" : "Another string value",
"displayName" : "Another string value",
"entryValue" : "Another string value"
} ]
},
"statisticsName" : "DEVICE_TOPN_MEMORY_UTILIZATION"
} ]
}
}