Example: op/statisticsService/opticalethernet/metrics/{metrics}?
TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalphysical/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=NCS2006-110& pmInterval=1-DAY
Since Product Version: 2.0
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v3/op/statisticsService/opticalethernet/metrics/{metric}Unmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
device String |
query |
Required The device name to which the interface belongs. |
ifName String |
query |
Required Name of the interface for which the metric data need to be fetched. |
metric String |
path |
Required The metric name for which the data need to be fetched. |
pmInterval String |
query |
Optional pmInterval15-MIN or 1-DAY |
location String |
query |
Optional location NEND or FEND |
timeInterval Integer |
query |
Optional Specifies the range of time (in hours). This field can contain values like 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. By default is 1 hour if neither timeInterval parameter nor the parameters startTime and endTime not provided. |
startTime Long |
query |
Optional Specifies the start time in seconds. The timeInterval parameter overrides this parameter. Mandatory param when endTime is used. |
endTime Long |
query |
Optional Specifies the end time in seconds. The timeInterval parameter overrides this parameter.Mandatory param when startTime is used. |
firstResult Integer |
query |
Optional Defines the offset from the first result you want to fetch. Default is 0. |
maxResults Integer |
query |
Optional Defines maximum amount of hits to be returned. Default is 20. |
sort String |
query |
Optional Comma-separated list of attribute names with their respective order. |
Response Parameters
Attribute | Description |
---|---|
currentDateTime String |
Current timestamp |
description String |
Metric description |
metricName String |
Metric name |
Metric data list |
|
resourceName String |
Resource name |
Properties of X values |
|
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://10.64.88.203/webacs/api/v3/op/statisticsService/opticalethernet/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v3/op/statisticsService/opticalethernet/metrics/{metric}" rootUrl="https://10.64.88.203/webacs/api/v3/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>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.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>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.88.203/webacs/api/v3/op/statisticsService/opticalethernet/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.64.88.203/webacs/api/v3/op/statisticsService/opticalethernet/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
}, {
"label" : "Another string value",
"maxVal" : 14.0,
"minVal" : 14.0,
"unit" : "STRING"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "String value"
}, {
"XValue" : "Another string value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "Another string value"
} ]
},
"resourceName" : "String value"
} ]
}
}