Since Product Version: 3.1
Resource URL
/webacs/api/v2/op/statisticsService/devices/metrics/{metric}Request Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
metric required |
path |
The metric name for which the data need to be fetched. |
String |
device required |
query |
The device IP or name for which the data need to be fetched. |
String |
lineCard required |
query |
The line card name for which the data need to be fetched. Required only for CPU Utilization metric. |
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 seconds. The timeInterval parameter overrides this parameter. |
Long |
endTime optional |
query |
Specifies the end time in seconds. The timeInterval parameter overrides this parameter. |
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/v2/op/statisticsService/devices/metrics/{metric}?device=172.20.151.111&timeInterval=4&lineCard=Supervisor%20Module-2
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v2/op/statisticsService/devices/metrics/{metric}?device=172.20.151.111&amp;timeInterval=4&amp;lineCard=Supervisor%20Module-2" 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/v2/op/statisticsService/devices/metrics/{metric}.json?device=172.20.151.111&timeInterval=4&lineCard=Supervisor%20Module-2
{ "mgmtResponse" : { "@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/devices/metrics/{metric}?device=172.20.151.111&timeInterval=4&lineCard=Supervisor%20Module-2", "@responseType" : "operation", "@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.0 ] } } ] }, "resourceName" : "String value", "xvalueProperty" : { "label" : "String value", "unit" : "NUMBER" }, "yvalueProperty" : { "yvalueProperty" : [ { "label" : "String value", "maxVal" : 4.0, "minVal" : 4.0, "unit" : "NUMBER" } ] } } ] } }