Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
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/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN}
Request Parameters
startTime
Long
|
path
|
RequiredstartTime in milliseconds
|
endTime
Long
|
path
|
RequiredendTime in milliseconds
|
topN
Integer
|
path
|
RequiredtopN
|
Request Payload Parameters
dSCPs
String[]
|
|
fromLGs
String[]
|
|
lGRole
String
|
|
lGs
String[]
|
|
pfREventMetricListDTO
PfREventMetricListDTO[]
|
|
anyAllCondition
String
|
|
eventName
String
|
|
metricListDTO
EventMetricDTO[]
|
|
leftOperand
String
|
|
operator
String
|
|
rightOperand
String
|
|
|
|
pfREvents
String[]
|
|
serviceProviders
String[]
|
|
toLGs
String[]
|
|
vrfs
String
|
|
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 Request Payload
https://localhost/webacs/api/v1/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5
<?xml version="1.0" ?>
<pfRLandingPageFilterDTO>
<dSCPs>
<dSCPs>String value</dSCPs>
</dSCPs>
<fromLGs>
<fromLGs>String value</fromLGs>
</fromLGs>
<LGRole>String value</LGRole>
<lGsList>
<lGs>String value</lGs>
</lGsList>
<pfREventMetricListDTOList>
<pfREventMetricListDTO>
<anyAllCondition>String value</anyAllCondition>
<eventName>String value</eventName>
<metricListDTOList>
<metricListDTO>
<leftOperand>String value</leftOperand>
<operator>String value</operator>
<rightOperand>String value</rightOperand>
</metricListDTO>
</metricListDTOList>
</pfREventMetricListDTO>
</pfREventMetricListDTOList>
<pfREventsList>
<pfREvents>String value</pfREvents>
</pfREventsList>
<serviceProvidersList>
<serviceProviders>String value</serviceProviders>
</serviceProvidersList>
<toLGs>
<toLGs>String value</toLGs>
</toLGs>
<vrfs>String value</vrfs>
</pfRLandingPageFilterDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5.json
{
"pfRLandingPageFilterDTO" : {
"dSCPs" : {
"dSCPs" : "String value"
},
"fromLGs" : {
"fromLGs" : "String value"
},
"LGRole" : "String value",
"lGsList" : {
"lGs" : "String value"
},
"pfREventMetricListDTOList" : {
"pfREventMetricListDTO" : {
"anyAllCondition" : "String value",
"eventName" : "String value",
"metricListDTOList" : {
"metricListDTO" : {
"leftOperand" : "String value",
"operator" : "String value",
"rightOperand" : "String value"
}
}
}
},
"pfREventsList" : {
"pfREvents" : "String value"
},
"serviceProvidersList" : {
"serviceProviders" : "String value"
},
"toLGs" : {
"toLGs" : "String value"
},
"vrfs" : "String value"
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/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/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/pfrMonitoringExt\/getServiceProviderUsageVsDSCPChart\/1465200910\/1465204510\/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 Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
path
|
RequiredstartTime in milliseconds
|
endTime
Long
|
path
|
RequiredendTime in milliseconds
|
topN
Integer
|
path
|
RequiredtopN
|
Request Payload Parameters
dSCPs
String[]
|
|
fromLGs
String[]
|
|
lGRole
String
|
|
lGs
String[]
|
|
pfREventMetricListDTO
PfREventMetricListDTO[]
|
|
anyAllCondition
String
|
|
eventName
String
|
|
metricListDTO
EventMetricDTO[]
|
|
leftOperand
String
|
|
operator
String
|
|
rightOperand
String
|
|
|
|
pfREvents
String[]
|
|
serviceProviders
String[]
|
|
toLGs
String[]
|
|
vrfs
String
|
|
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 Request Payload
https://localhost/webacs/api/v2/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5
<?xml version="1.0" ?>
<pfRLandingPageFilterDTO>
<dSCPs>
<dSCPs>String value</dSCPs>
</dSCPs>
<fromLGs>
<fromLGs>String value</fromLGs>
</fromLGs>
<LGRole>String value</LGRole>
<lGsList>
<lGs>String value</lGs>
</lGsList>
<pfREventMetricListDTOList>
<pfREventMetricListDTO>
<anyAllCondition>String value</anyAllCondition>
<eventName>String value</eventName>
<metricListDTOList>
<metricListDTO>
<leftOperand>String value</leftOperand>
<operator>String value</operator>
<rightOperand>String value</rightOperand>
</metricListDTO>
</metricListDTOList>
</pfREventMetricListDTO>
</pfREventMetricListDTOList>
<pfREventsList>
<pfREvents>String value</pfREvents>
</pfREventsList>
<serviceProvidersList>
<serviceProviders>String value</serviceProviders>
</serviceProvidersList>
<toLGs>
<toLGs>String value</toLGs>
</toLGs>
<vrfs>String value</vrfs>
</pfRLandingPageFilterDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5.json
{
"pfRLandingPageFilterDTO" : {
"LGRole" : "String value",
"dSCPs" : {
"dSCPs" : [ "String value" ]
},
"fromLGs" : {
"fromLGs" : [ "String value" ]
},
"lGsList" : {
"lGs" : [ "String value" ]
},
"pfREventMetricListDTOList" : {
"pfREventMetricListDTO" : [ {
"anyAllCondition" : "String value",
"eventName" : "String value",
"metricListDTOList" : {
"metricListDTO" : [ {
"leftOperand" : "String value",
"operator" : "String value",
"rightOperand" : "String value"
} ]
}
} ]
},
"pfREventsList" : {
"pfREvents" : [ "String value" ]
},
"serviceProvidersList" : {
"serviceProviders" : [ "String value" ]
},
"toLGs" : {
"toLGs" : [ "String value" ]
},
"vrfs" : "String value"
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/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/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/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 Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
path
|
RequiredstartTime in milliseconds
|
endTime
Long
|
path
|
RequiredendTime in milliseconds
|
topN
Integer
|
path
|
RequiredtopN
|
Request Payload Parameters
dSCPs
String[]
|
|
fromLGs
String[]
|
|
lGRole
String
|
|
lGs
String[]
|
|
pfREventMetricListDTO
PfREventMetricListDTO[]
|
|
anyAllCondition
String
|
|
eventName
String
|
|
metricListDTO
EventMetricDTO[]
|
|
leftOperand
String
|
|
operator
String
|
|
rightOperand
String
|
|
|
|
pfREvents
String[]
|
|
serviceProviders
String[]
|
|
toLGs
String[]
|
|
vrfs
String
|
|
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 Request Payload
https://localhost/webacs/api/v3/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5
<?xml version="1.0" ?>
<pfRLandingPageFilterDTO>
<dSCPs>
<dSCPs>String value</dSCPs>
<dSCPs>Another string value</dSCPs>
</dSCPs>
<fromLGs>
<fromLGs>String value</fromLGs>
<fromLGs>Another string value</fromLGs>
</fromLGs>
<LGRole>String value</LGRole>
<lGsList>
<lGs>String value</lGs>
<lGs>Another string value</lGs>
</lGsList>
<pfREventMetricListDTOList>
<pfREventMetricListDTO>
<anyAllCondition>String value</anyAllCondition>
<eventName>String value</eventName>
<metricListDTOList>
<metricListDTO>
<leftOperand>String value</leftOperand>
<operator>String value</operator>
<rightOperand>String value</rightOperand>
</metricListDTO>
<metricListDTO>
<leftOperand>Another string value</leftOperand>
<operator>Another string value</operator>
<rightOperand>Another string value</rightOperand>
</metricListDTO>
</metricListDTOList>
</pfREventMetricListDTO>
<pfREventMetricListDTO>
<anyAllCondition>Another string value</anyAllCondition>
<eventName>Another string value</eventName>
<metricListDTOList>
<metricListDTO>
<leftOperand>String value</leftOperand>
<operator>String value</operator>
<rightOperand>String value</rightOperand>
</metricListDTO>
<metricListDTO>
<leftOperand>Another string value</leftOperand>
<operator>Another string value</operator>
<rightOperand>Another string value</rightOperand>
</metricListDTO>
</metricListDTOList>
</pfREventMetricListDTO>
</pfREventMetricListDTOList>
<pfREventsList>
<pfREvents>String value</pfREvents>
<pfREvents>Another string value</pfREvents>
</pfREventsList>
<serviceProvidersList>
<serviceProviders>String value</serviceProviders>
<serviceProviders>Another string value</serviceProviders>
</serviceProvidersList>
<toLGs>
<toLGs>String value</toLGs>
<toLGs>Another string value</toLGs>
</toLGs>
<vrfs>String value</vrfs>
</pfRLandingPageFilterDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5.json
{
"pfRLandingPageFilterDTO" : {
"LGRole" : "String value",
"dSCPs" : {
"dSCPs" : [ "String value", "Another string value" ]
},
"fromLGs" : {
"fromLGs" : [ "String value", "Another string value" ]
},
"lGsList" : {
"lGs" : [ "String value", "Another string value" ]
},
"pfREventMetricListDTOList" : {
"pfREventMetricListDTO" : [ {
"anyAllCondition" : "String value",
"eventName" : "String value",
"metricListDTOList" : {
"metricListDTO" : [ {
"leftOperand" : "String value",
"operator" : "String value",
"rightOperand" : "String value"
}, {
"leftOperand" : "Another string value",
"operator" : "Another string value",
"rightOperand" : "Another string value"
} ]
}
}, {
"anyAllCondition" : "Another string value",
"eventName" : "Another string value",
"metricListDTOList" : {
"metricListDTO" : [ {
"leftOperand" : "String value",
"operator" : "String value",
"rightOperand" : "String value"
}, {
"leftOperand" : "Another string value",
"operator" : "Another string value",
"rightOperand" : "Another string value"
} ]
}
} ]
},
"pfREventsList" : {
"pfREvents" : [ "String value", "Another string value" ]
},
"serviceProvidersList" : {
"serviceProviders" : [ "String value", "Another string value" ]
},
"toLGs" : {
"toLGs" : [ "String value", "Another string value" ]
},
"vrfs" : "String value"
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/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>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/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"
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
startTime
Long
|
path
|
RequiredstartTime in milliseconds
|
endTime
Long
|
path
|
RequiredendTime in milliseconds
|
topN
Integer
|
path
|
RequiredtopN
|
Request Payload Parameters
dSCPs
String[]
|
|
fromLGs
String[]
|
|
lGRole
String
|
|
lGs
String[]
|
|
pfREventMetricListDTO
PfREventMetricListDTO[]
|
|
anyAllCondition
String
|
|
eventName
String
|
|
metricListDTO
EventMetricDTO[]
|
|
leftOperand
String
|
|
operator
String
|
|
rightOperand
String
|
|
|
|
pfREvents
String[]
|
|
serviceProviders
String[]
|
|
toLGs
String[]
|
|
vrfs
String
|
|
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 Request Payload
https://localhost/webacs/api/v4/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5
<?xml version="1.0" ?>
<pfRLandingPageFilterDTO>
<dSCPs>
<dSCPs>String value</dSCPs>
<dSCPs>Another string value</dSCPs>
</dSCPs>
<fromLGs>
<fromLGs>String value</fromLGs>
<fromLGs>Another string value</fromLGs>
</fromLGs>
<LGRole>String value</LGRole>
<lGsList>
<lGs>String value</lGs>
<lGs>Another string value</lGs>
</lGsList>
<pfREventMetricListDTOList>
<pfREventMetricListDTO>
<anyAllCondition>String value</anyAllCondition>
<eventName>String value</eventName>
<metricListDTOList>
<metricListDTO>
<leftOperand>String value</leftOperand>
<operator>String value</operator>
<rightOperand>String value</rightOperand>
</metricListDTO>
<metricListDTO>
<leftOperand>Another string value</leftOperand>
<operator>Another string value</operator>
<rightOperand>Another string value</rightOperand>
</metricListDTO>
</metricListDTOList>
</pfREventMetricListDTO>
<pfREventMetricListDTO>
<anyAllCondition>Another string value</anyAllCondition>
<eventName>Another string value</eventName>
<metricListDTOList>
<metricListDTO>
<leftOperand>String value</leftOperand>
<operator>String value</operator>
<rightOperand>String value</rightOperand>
</metricListDTO>
<metricListDTO>
<leftOperand>Another string value</leftOperand>
<operator>Another string value</operator>
<rightOperand>Another string value</rightOperand>
</metricListDTO>
</metricListDTOList>
</pfREventMetricListDTO>
</pfREventMetricListDTOList>
<pfREventsList>
<pfREvents>String value</pfREvents>
<pfREvents>Another string value</pfREvents>
</pfREventsList>
<serviceProvidersList>
<serviceProviders>String value</serviceProviders>
<serviceProviders>Another string value</serviceProviders>
</serviceProvidersList>
<toLGs>
<toLGs>String value</toLGs>
<toLGs>Another string value</toLGs>
</toLGs>
<vrfs>String value</vrfs>
</pfRLandingPageFilterDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5.json
{
"pfRLandingPageFilterDTO" : {
"LGRole" : "String value",
"dSCPs" : {
"dSCPs" : [ "String value", "Another string value" ]
},
"fromLGs" : {
"fromLGs" : [ "String value", "Another string value" ]
},
"lGsList" : {
"lGs" : [ "String value", "Another string value" ]
},
"pfREventMetricListDTOList" : {
"pfREventMetricListDTO" : [ {
"anyAllCondition" : "String value",
"eventName" : "String value",
"metricListDTOList" : {
"metricListDTO" : [ {
"leftOperand" : "String value",
"operator" : "String value",
"rightOperand" : "String value"
}, {
"leftOperand" : "Another string value",
"operator" : "Another string value",
"rightOperand" : "Another string value"
} ]
}
}, {
"anyAllCondition" : "Another string value",
"eventName" : "Another string value",
"metricListDTOList" : {
"metricListDTO" : [ {
"leftOperand" : "String value",
"operator" : "String value",
"rightOperand" : "String value"
}, {
"leftOperand" : "Another string value",
"operator" : "Another string value",
"rightOperand" : "Another string value"
} ]
}
} ]
},
"pfREventsList" : {
"pfREvents" : [ "String value", "Another string value" ]
},
"serviceProvidersList" : {
"serviceProviders" : [ "String value", "Another string value" ]
},
"toLGs" : {
"toLGs" : [ "String value", "Another string value" ]
},
"vrfs" : "String value"
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/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>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/5.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/1465200910/1465204510/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"
} ]
}
}