Fetches performance data of a given metric or metrics for a specific interface and EVC over a given period.
Examples:
op/statisticsService/me1200qos/metrics/stats?metrics=tx_yellow_framerate,rx_yellow_framerate& startTime=1498995959350&endTime=1498999559350&metricDataType=STATS& deviceName=ME-1200-1&ifName=GigabitEthernet 1/3.ECE.40& evcId=1&tableName=EVC
op/statisticsService/me1200qos/metrics/txyellowbitrate,rxyellowbitrate?startTime=1498995959350 &endTime=1498999559350&metricDataType=TIME_SERIES&deviceName=ME-1200-1& ifName=GigabitEthernet 1/3.ECE.40&evcId=1&tableName=EVC
Since Product Version: 2.0
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
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 URL
/webacs/api/v1/op/statisticsService/me1200qos/metrics/{metric}
Request Parameters
metric
String
|
path
|
RequiredDefines the name of the metric for which the data needs to be fetched
|
deviceName
String
|
query
|
RequiredDefines the device name of the device to which the ME1200 QoS belongs.
|
ifName
String
|
query
|
RequiredDefines the interface name on which the ME 1200 QoS statistics will be fetched
|
evcId
Integer
|
query
|
RequiredDefines the EVC iID of ME 1200 QoS policy.
|
tableName
String
|
query
|
RequiredDefines the table name on which the ME 1200 QoS statistics will be fetched.
|
timeInterval
Integer
|
query
|
OptionalFetches the data for the last specified number of hours. Applicable values are 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. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided.
|
startTime
Long
|
query
|
OptionalSpecifies the start time in milliseconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in milliseconds. 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 the maximum number of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalDefines a comma-separated list of attribute names with their respective order.
|
metricDataType
String
|
query
|
OptionalDetermines the query type to retrieve the KPi. Valid values are TOP_N or TIME_SERIES
|
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/v1/op/statisticsService/me1200qos/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsService/me1200qos/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/me1200qos/metrics/{metric}.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/me1200qos\/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"
}
}
}
}
}
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/me1200qos/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
metric
String
|
path
|
RequiredDefines the name of the metric for which the data needs to be fetched
|
deviceName
String
|
query
|
RequiredDefines the device name of the device to which the ME1200 QoS belongs.
|
ifName
String
|
query
|
RequiredDefines the interface name on which the ME 1200 QoS statistics will be fetched
|
evcId
Integer
|
query
|
RequiredDefines the EVC iID of ME 1200 QoS policy.
|
tableName
String
|
query
|
RequiredDefines the table name on which the ME 1200 QoS statistics will be fetched.
|
timeInterval
Integer
|
query
|
OptionalFetches the data for the last specified number of hours. Applicable values are 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. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided.
|
startTime
Long
|
query
|
OptionalSpecifies the start time in milliseconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in milliseconds. 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 the maximum number of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalDefines a comma-separated list of attribute names with their respective order.
|
metricDataType
String
|
query
|
OptionalDetermines the query type to retrieve the KPi. Valid values are TOP_N or TIME_SERIES
|
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/me1200qos/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v2/op/statisticsService/me1200qos/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/me1200qos/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/me1200qos/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/me1200qos/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
metric
String
|
path
|
RequiredDefines the name of the metric for which the data needs to be fetched
|
deviceName
String
|
query
|
RequiredDefines the device name of the device to which the ME1200 QoS belongs.
|
ifName
String
|
query
|
RequiredDefines the interface name on which the ME 1200 QoS statistics will be fetched
|
evcId
Integer
|
query
|
RequiredDefines the EVC iID of ME 1200 QoS policy.
|
tableName
String
|
query
|
RequiredDefines the table name on which the ME 1200 QoS statistics will be fetched.
|
timeInterval
Integer
|
query
|
OptionalFetches the data for the last specified number of hours. Applicable values are 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. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided.
|
startTime
Long
|
query
|
OptionalSpecifies the start time in milliseconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in milliseconds. 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 the maximum number of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalDefines a comma-separated list of attribute names with their respective order.
|
metricDataType
String
|
query
|
OptionalDetermines the query type to retrieve the KPi. Valid values are TOP_N or TIME_SERIES
|
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/me1200qos/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v3/op/statisticsService/me1200qos/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/me1200qos/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.25.123.114/webacs/api/v3/op/statisticsService/me1200qos/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/me1200qos/metrics/{metric}
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
metric
String
|
path
|
RequiredDefines the name of the metric for which the data needs to be fetched
|
deviceName
String
|
query
|
RequiredDefines the device name of the device to which the ME1200 QoS belongs.
|
ifName
String
|
query
|
RequiredDefines the interface name on which the ME 1200 QoS statistics will be fetched
|
evcId
Integer
|
query
|
RequiredDefines the EVC iID of ME 1200 QoS policy.
|
tableName
String
|
query
|
RequiredDefines the table name on which the ME 1200 QoS statistics will be fetched.
|
timeInterval
Integer
|
query
|
OptionalFetches the data for the last specified number of hours. Applicable values are 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. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided.
|
startTime
Long
|
query
|
OptionalSpecifies the start time in milliseconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
OptionalSpecifies the end time in milliseconds. 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 the maximum number of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalDefines a comma-separated list of attribute names with their respective order.
|
metricDataType
String
|
query
|
OptionalDetermines the query type to retrieve the KPi. Valid values are TOP_N or TIME_SERIES
|
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/me1200qos/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v4/op/statisticsService/me1200qos/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/me1200qos/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.25.123.114/webacs/api/v4/op/statisticsService/me1200qos/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"
} ]
}
}