Example: op/statisticsService/cem/metrics/receivedRbits,receivedLbits?startTime=1498996800749& endTime=1499000400749&metricDataType=TIME_SERIES&deviceName=10.56.23.109& ifName=CEM-PG1&cemId=16001
OR TOP N performance data of a given metric for all the CEM interfaces over a given time period.
Example: op/statisticsService/cem/metrics/receivedRbits?startTime=1498996800749& endTime=1499000400749&metricDataType=TOP_N
Since Product Version: 2.0
Resource URL
/webacs/api/v1/op/statisticsService/cem/metrics/{metric}Request Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
metric required |
path |
Defines the name of the metric for which the data needs to be fetched |
String |
deviceName required |
query |
Defines the device name of the device to which the ME1200 QoS belongs. |
String |
ifName required |
query |
Defines the interface name on which the CEM statistics will be fetched |
Integer |
cemId required |
query |
Defines the CEM ID of CEM policy. |
Integer |
timeInterval optional |
query |
Fetches the data for the last specified number of hours. Applicable values are 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided. |
Long |
startTime optional |
query |
Specifies the start time in milliseconds. The timeInterval parameter overrides this parameter. |
Long |
endTime optional |
query |
Specifies the end time in milliseconds. The timeInterval parameter overrides this parameter. |
Integer |
firstResult optional |
query |
Defines the offset from the first result you want to fetch. Default is 0. |
Integer |
maxResults optional |
query |
Defines the maximum number of hits to be returned. Default is 20. |
String |
sort optional |
query |
Defines a comma-separated list of attribute names with their respective order. |
String |
metricDataType optional |
query |
Determines the query type to retrieve the KPi. Valid values are TOP_N or TIME_SERIES |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
String |
currentDateTime |
Current timestamp |
String |
description |
Metric description |
String |
metricName |
Metric name |
metricRows |
Metric data list |
|
String |
resourceName |
Resource name |
xValueProperty |
Properties of X values |
|
yValueProperty |
Properties of Y 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://172.25.123.114/webacs/api/v1/op/statisticsService/cem/metrics/{metric}
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsService/cem/metrics/{metric}" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <metricData> <currentDateTime>String value</currentDateTime> <description>String value</description> <metricName>String value</metricName> <metricRows> <metricRows> <issue>String value</issue> <XValue>String value</XValue> <YLabels> <YLabels>String value</YLabels> </YLabels> <YValues> <YValues>15.0</YValues> </YValues> </metricRows> </metricRows> <resourceName>String value</resourceName> <XValueProperty> <label>String value</label> <unit>NUMBER</unit> </XValueProperty> <YValueProperty> <YValueProperty> <label>String value</label> <maxVal>4.0</maxVal> <minVal>4.0</minVal> <unit>NUMBER</unit> </YValueProperty> </YValueProperty> </metricData> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/statisticsService/cem/metrics/{metric}.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/cem\/metrics\/{ metric }", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "metricData" : { "currentDateTime" : "String value", "description" : "String value", "metricName" : "String value", "metricRows" : { "metricRows" : { "issue" : "String value", "XValue" : "String value", "YLabels" : { "YLabels" : "String value" }, "YValues" : { "YValues" : 15 } } }, "resourceName" : "String value", "XValueProperty" : { "label" : "String value", "unit" : "NUMBER" }, "YValueProperty" : { "YValueProperty" : { "label" : "String value", "maxVal" : 4, "minVal" : 4, "unit" : "NUMBER" } } } } }