Examples:
op/statisticsService/opticalSfp/metrics/stats?metrics=Voltage,RxPower,Temperature& startTime=1498995120297&endTime=1498998720297&metricDataType=STATS& device=10.56.23.27&ifName=GigabitEthernet0/6
op/statisticsService/opticalSfp/metrics/Voltage,RxPower,Temperature?startTime=1498995120297& endTime=1498998720297&metricDataType=TIME_SERIES&device=10.56.23.27& ifName=GigabitEthernet0/6
Since Product Version: 2.0
Resource URL
/webacs/api/v1/op/statisticsService/opticalSfp/metrics/{metric}Request Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
metric required |
path |
The name of the metric for which the data needs to be fetched |
String |
device required |
query |
The IP address of the device to which the optical SFP transceiver belongs. |
String |
ifName required |
query |
The name of the interface to which the optical SFP transceivers belongs. |
Integer |
timeInterval optional |
query |
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. |
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 maximum amount 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 retirieve 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/opticalSfp/metrics/{metric}
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsService/opticalSfp/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/opticalSfp/metrics/{metric}.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/opticalSfp\/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" } } } } }