Get Metrics for a Device
get
/api/metric/NetworkTraffic
Get the metrics for a specified device that match the specified query parameters. If no optional query parameters are specified, all metrics for the device are returned.
Request
Query Parameters
-
DeviceName(required): string
The composite name of the device to get metrics for. Based on custom name, DNS name, sys name, and IP addresses.Example:
router.example.com
-
DeviceZoneName(required): string
The zone name of the device to get metrics for.Example:
Oracle Lab - Network Equipment
-
TimeRange(required): string
A shorthand string that encompasses StartTime and StopTime. Ignored if StartTime is specified. Default to the last 24 hours if no value is provided.Example:
now-24h..now
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
group: object
The group parameter. It groups results by field and direction.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the group.Example:ASC
-
property(required):
string
The field name to group by.Example:
name
-
direction(required):
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricNetworkTrafficRead
Type:
Show Source
object
-
Abbr: string
Metric AbbreviationExample:
s
-
DeviceID: string
Device ID specified for view of metrics. It can be a single value or a comma-separated list of ID'sExample:
1555
-
DeviceName: string
Device NameExample:
router.example.com
-
DeviceZoneID: integer
DeviceZone ID to indicate which devices to includeExample:
9
-
Direction: integer
DirectionExample:
0
-
Factor: integer
FactorExample:
1
-
IfSpeed: string
IfSpeedExample:
oracle.doceng.json.BetterJsonNull@61d87509
-
InboundAvailability: number
Inbound AvailabilityExample:
100
-
InboundAverageUtilization: number
Inbound Average UtilizationExample:
oracle.doceng.json.BetterJsonNull@74c997b1
-
InboundAverageValue: number
Inbound Average ValueExample:
7.496613939244192E-4
-
InboundLastUtilization: number
Inbound Last UtilizationExample:
oracle.doceng.json.BetterJsonNull@17f8c75e
-
InboundLastValue: number
Inbound Last ValueExample:
7.76863098144531E-4
-
InboundMaximumUtilization: number
Inbound Maximum UtilizationExample:
oracle.doceng.json.BetterJsonNull@2d7bfb13
-
InboundMaximumValue: number
Inbound Maximum ValueExample:
0.0022432804107666
-
InboundMinimumUtilization: number
Inbound Minimum UtilizationExample:
oracle.doceng.json.BetterJsonNull@50e0541
-
InboundMinimumValue: number
Inbound Minimum ValueExample:
3.22437286376953E-4
-
InboundPeakUtilization: number
Inbound Peak UtilizationExample:
oracle.doceng.json.BetterJsonNull@29c471f6
-
InboundPeakValue: number
Inbound Peak ValueExample:
0.0022432804107666
-
InboundTrend: number
Inbound TrendExample:
0
-
InstanceName: string
Instance NameExample:
Device
-
Measurement: string
MeasurementExample:
metrictype_Latency
-
MetricGroupID: integer
Metric Group ID specified to limit which metrics are includedExample:
6
-
MetricID: integer
May be a single value or a comma-separated listExample:
642677
-
MetricTypeName: string
Metric Type NameExample:
Latency
-
OriginalMetricTypeName: string
Original Metric Type NameExample:
Latency
-
OutboundAvailability: number
Inbound Last UtilizationExample:
0
-
OutboundAverageUtilization: number
Outbound Average UtilizationExample:
0
-
OutboundAverageValue: number
Outbound Average ValueExample:
0
-
OutboundLastUtilization: number
Outbound Last UtilizationExample:
0
-
OutboundLastValue: integer
Outbound Last ValueExample:
0
-
OutboundMaximumUtilization: number
Outbound Maximum UtilizationExample:
0
-
OutboundMaximumValue: number
Outbound Maximum ValueExample:
0
-
OutboundMinimumUtilization: number
Outbound Minimum UtilizationExample:
0
-
OutboundMinimumValue: number
Outbound Minimum ValueExample:
0
-
OutboundPeakUtilization: number
Outbound Peak UtilizationExample:
0
-
OutboundPeakValue: number
Outbound Peak ValueExample:
0
-
OutboundTrend: number
Out bound TrendExample:
0
-
ParentDeviceID: integer
Parent Device IDExample:
0
-
SourceInstanceName: string
Source Instance NameExample:
Device
-
UnitDivision: integer
Unit DivisionExample:
60
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object