Since Product Version: 2.0
Resource URL
/webacs/api/v1/op/statisticsService/circuits/metrics/{metric}Request Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
metric required |
path |
Metric name, e.g. Loss or OPT_MAX. |
String |
circuitId required |
query |
Id of the circuit. |
String |
circuitType required |
query |
Type of the circuit, E.g. OCHCC or EVC. |
Double |
timeInterval optional |
query |
Time interval of the performance data (in hours), Default is set to 6 hours. |
Long |
maxResults optional |
query |
Maximum number of results to display, Default is to show all results. |
String |
location optional |
query |
Indicates if the endpoint is NEND or FEND (Relevant only to optical circuits) |
String |
deviceId optional |
query |
Id of the device (Relevant only to optical circuits), E.g. 566622_10.58.234.67. |
String |
endpointName optional |
query |
Endpoint name (Relevant only to optical circuits), E.g. CHAN-4-6-2. |
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/circuits/metrics/{metric}
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsService/circuits/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/circuits/metrics/{metric}.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/circuits\/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" } } } } }