API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource unavailable for this API version
This resource was introduced in API version 2.
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/statisticsService/opticalphysical/metrics/{metric}
Request Parameters
device
String
|
query
|
RequiredThe device name to which the interface belongs.
|
ifName
String
|
query
|
RequiredName of the interface for which the metric data need to be fetched.
|
metric
String
|
path
|
RequiredThe metric name for which the data need to be fetched.
|
pmInterval
String
|
query
|
OptionalpmInterval 15-MIN or 1-DAY
|
location
String
|
query
|
Optionallocation NEND or FEND
|
timeInterval
Integer
|
query
|
OptionalSpecifies 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
|
OptionalSpecifies the start time in seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in seconds. The timeInterval parameter overrides this parameter.
|
firstResult
Integer
|
query
|
OptionalDefines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
OptionalDefines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalComma-separated list of attribute names with their respective order.
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yLabels
String[]
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
Unit for X
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- PACKETS
- FRAMES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
- DBM
- VOLT
- MICROSECOND
- MILLIAMP
- CELSIUS
- DECIBEL
- KBITS_PER_SEC
- BUFFER_UNDER_RUN_TIMES
- FAILURE_COUNT
- PS
- PS2
- RAD_PER_SECOND
- DB
- RATIO
- ERROR_SECONDS
- CODE_VIOLATIONS
- BLOCK_ERRORS
- UNCORRECTABLE_WORDS
- BIT_ERRORS
- BLOCKS
- MA
- ERRORS
- BIT_ERRORS_RATE
- BIT
- BUFFER_OVERRUN_TIMES
- N_A
- PACKETS_PER_SECOND
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
Unit for Y
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- PACKETS
- FRAMES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
- DBM
- VOLT
- MICROSECOND
- MILLIAMP
- CELSIUS
- DECIBEL
- KBITS_PER_SEC
- BUFFER_UNDER_RUN_TIMES
- FAILURE_COUNT
- PS
- PS2
- RAD_PER_SECOND
- DB
- RATIO
- ERROR_SECONDS
- CODE_VIOLATIONS
- BLOCK_ERRORS
- UNCORRECTABLE_WORDS
- BIT_ERRORS
- BLOCKS
- MA
- ERRORS
- BIT_ERRORS_RATE
- BIT
- BUFFER_OVERRUN_TIMES
- N_A
- PACKETS_PER_SECOND
|
|
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/opticalphysical/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v2/op/statisticsService/opticalphysical/metrics/{metric}" rootUrl="https://172.25.123.114/webacs/api/v2/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/opticalphysical/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/opticalphysical/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://172.25.123.114/webacs/api/v2/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YLabels" : {
"ylabels" : [ "String value" ]
},
"YValues" : {
"yvalues" : [ 15.0 ]
},
"issue" : "String value"
} ]
},
"resourceName" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/statisticsService/opticalphysical/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
RequiredThe device name to which the interface belongs.
|
ifName
String
|
query
|
RequiredName of the interface for which the metric data need to be fetched.
|
metric
String
|
path
|
RequiredThe metric name for which the data need to be fetched.
|
pmInterval
String
|
query
|
OptionalpmInterval 15-MIN or 1-DAY
|
location
String
|
query
|
Optionallocation NEND or FEND
|
timeInterval
Integer
|
query
|
OptionalSpecifies 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
|
OptionalSpecifies the start time in seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in seconds. The timeInterval parameter overrides this parameter.
|
firstResult
Integer
|
query
|
OptionalDefines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
OptionalDefines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalComma-separated list of attribute names with their respective order.
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yLabels
String[]
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
Unit for X
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- PACKETS
- FRAMES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
- DBM
- VOLT
- MICROSECOND
- MILLIAMP
- CELSIUS
- DECIBEL
- KBITS_PER_SEC
- BUFFER_UNDER_RUN_TIMES
- FAILURE_COUNT
- PS
- PS2
- RAD_PER_SECOND
- DB
- RATIO
- ERROR_SECONDS
- CODE_VIOLATIONS
- BLOCK_ERRORS
- UNCORRECTABLE_WORDS
- BIT_ERRORS
- BLOCKS
- MA
- ERRORS
- BIT_ERRORS_RATE
- BIT
- BUFFER_OVERRUN_TIMES
- N_A
- PACKETS_PER_SECOND
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
Unit for Y
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- PACKETS
- FRAMES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
- DBM
- VOLT
- MICROSECOND
- MILLIAMP
- CELSIUS
- DECIBEL
- KBITS_PER_SEC
- BUFFER_UNDER_RUN_TIMES
- FAILURE_COUNT
- PS
- PS2
- RAD_PER_SECOND
- DB
- RATIO
- ERROR_SECONDS
- CODE_VIOLATIONS
- BLOCK_ERRORS
- UNCORRECTABLE_WORDS
- BIT_ERRORS
- BLOCKS
- MA
- ERRORS
- BIT_ERRORS_RATE
- BIT
- BUFFER_OVERRUN_TIMES
- N_A
- PACKETS_PER_SECOND
|
|
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/v3/op/statisticsService/opticalphysical/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v3/op/statisticsService/opticalphysical/metrics/{metric}" rootUrl="https://172.25.123.114/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://172.25.123.114/webacs/api/v3/op/statisticsService/opticalphysical/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.25.123.114/webacs/api/v3/op/statisticsService/opticalphysical/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://172.25.123.114/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"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/statisticsService/opticalphysical/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
RequiredThe device name to which the interface belongs.
|
ifName
String
|
query
|
RequiredName of the interface for which the metric data need to be fetched.
|
metric
String
|
path
|
RequiredThe metric name for which the data need to be fetched.
|
pmInterval
String
|
query
|
OptionalpmInterval 15-MIN or 1-DAY
|
location
String
|
query
|
Optionallocation NEND or FEND
|
timeInterval
Integer
|
query
|
OptionalSpecifies 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
|
OptionalSpecifies the start time in seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in seconds. The timeInterval parameter overrides this parameter.
|
firstResult
Integer
|
query
|
OptionalDefines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
OptionalDefines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalComma-separated list of attribute names with their respective order.
|
Response Parameters
currentDateTime
String
|
|
description
String
|
|
metricName
String
|
|
metricRows
MetricRowDTO[]
|
|
issue
String
|
|
xValue
String
|
|
yLabels
String[]
|
|
yValues
Double[]
|
|
|
resourceName
String
|
|
xValueProperty
XValueProperty
|
|
label
String
|
|
unit
MetricUnitEnum
|
Unit for X
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- PACKETS
- FRAMES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
- DBM
- VOLT
- MICROSECOND
- MILLIAMP
- CELSIUS
- DECIBEL
- KBITS_PER_SEC
- BUFFER_UNDER_RUN_TIMES
- FAILURE_COUNT
- PS
- PS2
- RAD_PER_SECOND
- DB
- RATIO
- ERROR_SECONDS
- CODE_VIOLATIONS
- BLOCK_ERRORS
- UNCORRECTABLE_WORDS
- BIT_ERRORS
- BLOCKS
- MA
- ERRORS
- BIT_ERRORS_RATE
- BIT
- BUFFER_OVERRUN_TIMES
- N_A
- PACKETS_PER_SECOND
|
|
yValueProperty
YValueProperty[]
|
|
label
String
|
|
maxVal
double
|
|
minVal
double
|
|
unit
MetricUnitEnum
|
Unit for Y
Allowed values:
- NUMBER
- STRING
- PERCENTAGE
- SECOND
- MILLISECOND
- BYTE
- KB
- MB
- BITS_PER_SECOND
- BYTES_PER_SECOND
- PACKETS
- FRAMES_PER_SECOND
- KB_PER_SEC
- HERTZ
- MEGAHERTZ
- DISC_UNIT
- NETWORK_UNIT
- DBM
- VOLT
- MICROSECOND
- MILLIAMP
- CELSIUS
- DECIBEL
- KBITS_PER_SEC
- BUFFER_UNDER_RUN_TIMES
- FAILURE_COUNT
- PS
- PS2
- RAD_PER_SECOND
- DB
- RATIO
- ERROR_SECONDS
- CODE_VIOLATIONS
- BLOCK_ERRORS
- UNCORRECTABLE_WORDS
- BIT_ERRORS
- BLOCKS
- MA
- ERRORS
- BIT_ERRORS_RATE
- BIT
- BUFFER_OVERRUN_TIMES
- N_A
- PACKETS_PER_SECOND
|
|
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/v4/op/statisticsService/opticalphysical/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v4/op/statisticsService/opticalphysical/metrics/{metric}" rootUrl="https://172.25.123.114/webacs/api/v4/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://172.25.123.114/webacs/api/v4/op/statisticsService/opticalphysical/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.25.123.114/webacs/api/v4/op/statisticsService/opticalphysical/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://172.25.123.114/webacs/api/v4/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"
} ]
}
}