- /op/pfrMonitoringExt/getDscpAppUsage/1475824562/1476429362 --Returns WAN Link bandwidth usage in terms of data volume within the given startTime and endTime
- /op/pfrMonitoringExt/getDscpAppUsage/1475824562/1476429362?srcSiteName=BANGALORE&dstSiteName=SAN JOSE&managedIpBR=10.1.1.1&tunnelName=tunnel1&srcHierarchyPath=Location/All Locations&destHierarchyPath=Location/All Locations/INDIA --Returns WAN Link bandwidth usage in terms of data volume for the given site pair under srcHierarchyPath and destHierarchyPath within StartTime and endTime.
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/v1/op/pfrMonitoringExt/getDscpAppUsage/{startTime}/{endTime}Request Parameters
Attribute | Source | Description |
---|---|---|
startTime Long |
path |
RequiredSpecifies the start time in milli seconds to get the DSCP app usage from. |
endTime Long |
path |
RequiredSpecifies the start time in milli seconds to get the DSCP app usage to. |
srcSiteName String |
query |
OptionalOPTIONAL Specifies the source site to get the DSCP app usage. |
dstSiteName String |
query |
OptionalOPTIONAL Specifies the destination site to get the DSCP app usage. |
managedIpBR String |
query |
OptionalOPTIONAL Specifies the managed ip to get the DSCP app usage. |
tunnelName String |
query |
OptionalOPTIONAL Specifies the tunnel name to get the DSCP app usage. |
srcHierarchyPath String |
query |
OptionalOPTIONAL Specifies the source site hierarchy to get the DSCP app usage. |
destHierarchyPath String |
query |
OptionalOPTIONAL Specifies the destination site hierarchy to get the DSCP app usage. |
Response Parameters
Attribute | Description |
---|---|
The set of nested StatisticsDTO objects. |
|
The set of statistics entries with attribute name, display name, and value triplets belonging to a single entity for the given category of statistics. |
|
statisticsName StatisticsOperationTypeEnum |
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://localhost/webacs/api/v1/op/pfrMonitoringExt/getDscpAppUsage/1463999256/1465208856?srcSiteName="Site1"&dstSiteName="Site2"&managedIpBR="192.168.3.0"&tunnelName="tunnelName"&srcHierarchyPath="Location/All Locations/Site1&destHierarchyPath="Location/All Locations/Site1"
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/pfrMonitoringExt/getDscpAppUsage/1463999256/1465208856?srcSiteName=&quot;Site1&quot;&amp;dstSiteName=&quot;Site2&quot;&amp;managedIpBR=&quot;192.168.3.0&quot;&amp;tunnelName=&quot;tunnelName&quot;&amp;srcHierarchyPath=&quot;Location/All Locations/Site1&amp;destHierarchyPath=&quot;Location/All Locations/Site1&quot;
" rootUrl="https://localhost/webacs/api/v1/op">
<statisticsDTO>
<childStatistics>
<childStatistic>
<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>
</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://localhost/webacs/api/v1/op/pfrMonitoringExt/getDscpAppUsage/1463999256/1465208856.json?srcSiteName="Site1"&dstSiteName="Site2"&managedIpBR="192.168.3.0"&tunnelName="tunnelName"&srcHierarchyPath="Location/All Locations/Site1&destHierarchyPath="Location/All Locations/Site1"
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/pfrMonitoringExt\/getDscpAppUsage\/1463999256\/1465208856?srcSiteName="Site1"&dstSiteName="Site2"&managedIpBR="192.168.3.0"&tunnelName="tunnelName"&srcHierarchyPath="Location\/All Locations\/Site1&destHierarchyPath="Location\/All Locations\/Site1"\n\t\t\t\t\t",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"statisticsDTO" : {
"childStatistics" : {
"childStatistic" : {
"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"
}
},
"statisticEntries" : {
"statisticEntry" : {
"attributeName" : "String value",
"displayName" : "String value",
"entryValue" : "String value"
}
},
"statisticsName" : "DEVICE_TOPN_CPU_UTILIZATION"
}
}
}