1. REST API for Unified Assurance Core
  2. Tasks
  3. Metrics
  4. Network Traffic

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.
An example path with query parameters is:
/api/metric/NetworkTraffic?TimeRange=now-24h..now&DeviceName=router.example.com%3Bz3&page=1&start=0&limit=1000&group=%7B%22property%22%3A%22InstanceName%22%2C%22direction%22%3A%22ASC%22%7D&sort=%5B%7B%22property%22%3A%22InstanceName%22%2C%22direction%22%3A%22ASC%22%7D%2C%7B%22property%22%3A%22MetricTypeName%22%2C%22direction%22%3A%22ASC%22%7D%5D

Request

Query Parameters
  • The device name, including the zone ID (serialized device name). Oracle recommends including the zone ID with the device name. If you do not, you must include it in the DeviceZoneID parameter.
    Example:
    router.example.com;z1 OR router.example.com
  • The database ID of the device zone to get metrics for. Deprecated. Use serialized device name instead.
    Example:
    1
  • Match All
    • Shorthand string that encompasses the start and end times in RFC3339 format or relative time literal format. It will take precedence over StartTime if both are passed in.
      Example: now-24h..now
  • 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.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • 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
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The group parameter. It groups results by field and direction.
    This parameters value uses the following JSON format:
    {
    "property": "property",
    "direction": "direction"
    }
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • 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" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : metricNetworkTrafficRead
Type: object
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top

Examples

The following example shows how to use query parameters in Get Metrics for a Device requests. The parameters specify the device's serialized name (the device name appended with zone number), a time range, and standard pagination parameters, such as page, start, limit, and sort.

You can submit a request using cURL, an API client, or your browser.

http://hostFQDN/api/metric/NetworkTraffic?TimeRange=now-24h..now&DeviceName=router.example.com%3Bz3&page=1&start=0&limit=1000&group=%7B%22property%22%3A%22InstanceName%22%2C%22direction%22%3A%22ASC%22%7D&sort=%5B%7B%22property%22%3A%22InstanceName%22%2C%22direction%22%3A%22ASC%22%7D%2C%7B%22property%22%3A%22MetricTypeName%22%2C%22direction%22%3A%22ASC%22%7D%5D

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "success": "true",
  "message": "Loaded 1 entries",
  "total": "1",
  "data": [
    {
      "DeviceID": "1555",
      "ParentDeviceID": "0",
      "DeviceName": "router.example.com",
      "DeviceZoneID": "9",
      "MetricID": 642677,
      "Factor": "1",
      "MetricTypeName": "Latency",
      "OriginalMetricTypeName": "Latency",
      "Measurement": "metrictype_Latency",
      "Abbr": "s",
      "MetricGroupID": "6",
      "UnitDivision": "60",
      "Direction": "0",
      "InstanceName": "Device",
      "IfSpeed": null,
      "InboundAvailability": 100,
      "InboundTrend": "0",
      "InboundMinimumValue": 0.000322437286376953,
      "InboundMaximumValue": 0.0022432804107666,
      "InboundAverageValue": 0.0007496613939244192,
      "InboundPeakValue": 0.0022432804107666,
      "InboundLastValue": 0.000776863098144531,
      "InboundMinimumUtilization": null,
      "InboundMaximumUtilization": null,
      "InboundAverageUtilization": null,
      "InboundPeakUtilization": null,
      "InboundLastUtilization": null,
      "OutboundAvailability": "0",
      "OutboundTrend": "0",
      "OutboundMinimumValue": "0",
      "OutboundMaximumValue": "0",
      "OutboundAverageValue": "0",
      "OutboundPeakValue": "0",
      "OutboundLastValue": "0",
      "OutboundMinimumUtilization": "0",
      "OutboundMaximumUtilization": "0",
      "OutboundAverageUtilization": "0",
      "OutboundPeakUtilization": "0",
      "OutboundLastUtilization": "0",
      "SourceInstanceName": "Device"
    }
  ]
}
Back to Top