Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Understanding the IP/MPLSView Traffic Data API

    The traffic data API root is /IPMPLSView/API/v1/tenant/1/trafficData/1. It only allows GET requests.

    There is one traffic data collection schema for each IP/MPLSView instance, tied to the live network. The live network nodes and traffic data collection nodes are disjointed, but may intersect. Specific matching is done through the name specification.

    Table 1 lists the traffic data information-related APIs.

    Object

    URL

    Description

    Parameters

    Nodes

    /devices

    Returns the list of all devices configured for traffic collection. Returns all rows in the WRouter table.

    None

    Node

    /routerDetails

    Returns traffic information specific to a router identified by number or name.

    routerID: integer

    routerName: string

    Interface traffic

    /interfaceTraffic

    Provides interface traffic details for the specified router. A router ID or name must be specified.

    Required one of:

    • routerID: integer
    • routerName: string

    Optional Parameters:

    • interfaceDesc
    • interfaceID
    • startDate
    • endDate
    • limit

    Tunnel traffic

    /tunnelTraffic

    Returns tunnel traffic details for a router from the daily database tunnel traffic tables. A router ID or name must be specified.

    Required one of:

    • routerID: integer
    • routerName: string

    Optional Parameters:

    • interfaceDesc
    • interfaceID
    • startDate
    • endDate
    • limit

    Interface Traffic File

    /network/intfTraffic

    Reads contents of the /u/wand/data/.network/interface.traffic file.

    Required: None

    Network Interface

    /network/intfTraffic

    Returns traffic information for a network interface.

    Interface Details

    /interfaceDetails

    Returns network interface details for the specified router and all of its interfaces for the most recently completed traffic collection cycle. A router ID or name must be specified.

    Required:

    • routerID: integer - OR
    • routerName: string

    Class of Service Traffic Statistics

    /cosTraffic

    Returns database CoS traffic statistics collected for a specified device and interface. A router ID or name and interface description values are required.

    Returns all stats for either the current day (the default) or the specified startDate.

    Defaults to egress values.

    Note: CoS traffic statistics are only available for Juniper, Cisco, Alcatel-Lucent, and Huawei devices.

    Required:

    • routerID: integer - OR -
    • routerName: string
    • interfaceDesc: interface Description value

    Optional Parameters:

    • startDate: YYYYMMDD
    • limit: N
    • ingress—if included in the URL, retrieves ingress values

    Multicast traffic statistics

    /multiCastTraffic

    Returns database multicast traffic statistics collected for a specified device and interface. A router ID or name must be specified.

    Required:

    • routerID: integer - OR -
    • routerName: string

    Optional Parameters:

    • startDate: YYYYMMDD
    • limit: N

    Traffic Data Query Parameters

    Where applicable, query parameters are presented in the format: ?<parameter>=<value> .

    Modified: 2016-09-27