Gets a summary of the interface availability.
Since Product Version: 1.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
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/statisticsService/interface/availabilitySummary
Request Parameters
startTime
Long
|
query
|
Required
Specifies the start time in seconds to check the device availability summary from. (See 'range' for more details)
|
endTime
Long
|
query
|
Required
Specifies the end time in seconds to check the device availability summary to. (See 'range' for more details)
|
range
Integer
|
query
|
Required
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.
|
rangeString
String
|
query
|
Optional
Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.
|
source
String
|
query
|
Optional
An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.
|
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.
|
|
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.
|
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://10.64.88.203/webacs/api/v1/op/statisticsService/interface/availabilitySummary?range=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v1/op/statisticsService/interface/availabilitySummary?range=1" rootUrl="https://10.64.88.203/webacs/api/v1/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://10.64.88.203/webacs/api/v1/op/statisticsService/interface/availabilitySummary.json?range=1
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/statisticsService/interface/availabilitySummary?range=1",
"@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
"statisticsDTO" : [{
"childStatistics" : "",
"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" : "",
"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?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/statisticsService/interface/availabilitySummary
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
query
|
Required
Specifies the start time in seconds to check the device availability summary from. (See 'range' for more details)
|
endTime
Long
|
query
|
Required
Specifies the end time in seconds to check the device availability summary to. (See 'range' for more details)
|
range
Integer
|
query
|
Required
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.
|
rangeString
String
|
query
|
Optional
Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.
|
source
String
|
query
|
Optional
An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.
|
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.
|
|
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.
|
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://10.64.88.203/webacs/api/v2/op/statisticsService/interface/availabilitySummary?range=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v2/op/statisticsService/interface/availabilitySummary?range=1" rootUrl="https://10.64.88.203/webacs/api/v2/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://10.64.88.203/webacs/api/v2/op/statisticsService/interface/availabilitySummary.json?range=1
{
"mgmtResponse" : {
"@requestUrl" : "https://10.64.88.203/webacs/api/v2/op/statisticsService/interface/availabilitySummary?range=1",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v2/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?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/statisticsService/interface/availabilitySummary
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
query
|
Required
Specifies the start time in seconds to check the device availability summary from. (See 'range' for more details)
|
endTime
Long
|
query
|
Required
Specifies the end time in seconds to check the device availability summary to. (See 'range' for more details)
|
range
Integer
|
query
|
Required
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.
|
rangeString
String
|
query
|
Optional
Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.
|
source
String
|
query
|
Optional
An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.
|
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.
|
|
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.
|
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://10.64.88.203/webacs/api/v3/op/statisticsService/interface/availabilitySummary?range=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v3/op/statisticsService/interface/availabilitySummary?range=1" rootUrl="https://10.64.88.203/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://10.64.88.203/webacs/api/v3/op/statisticsService/interface/availabilitySummary.json?range=1
{
"mgmtResponse" : {
"@requestUrl" : "https://10.64.88.203/webacs/api/v3/op/statisticsService/interface/availabilitySummary?range=1",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/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?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/statisticsService/interface/availabilitySummary
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
query
|
Required
Specifies the start time in seconds to check the device availability summary from. (See 'range' for more details)
|
endTime
Long
|
query
|
Required
Specifies the end time in seconds to check the device availability summary to. (See 'range' for more details)
|
range
Integer
|
query
|
Required
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.
|
rangeString
String
|
query
|
Optional
Specifies the pie chart range list. The responses use the provided ranges in the same order. An example format which is the default when not specified: 0-25,76-100,51-75,26-50.
|
source
String
|
query
|
Optional
An optional filter parameter that can be used to provide the IP Address or a group ID to get a filtered response.
|
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.
|
|
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.
|
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://10.64.88.203/webacs/api/v4/op/statisticsService/interface/availabilitySummary?range=1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v4/op/statisticsService/interface/availabilitySummary?range=1" rootUrl="https://10.64.88.203/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://10.64.88.203/webacs/api/v4/op/statisticsService/interface/availabilitySummary.json?range=1
{
"mgmtResponse" : {
"@requestUrl" : "https://10.64.88.203/webacs/api/v4/op/statisticsService/interface/availabilitySummary?range=1",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/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"
} ]
}
}