Query WAN Neighbor Statistics (v2.0)

POST 
/sdwan/v2.0/api/monitor/aggregates/multicast/wan_neighbor

Query all the WAN neighbor statistics.

Request

application/json

Body

Details of object stats query

end_time date

The end time of the multicast statistics query.

filter MulticastWANNeighborStatsFilterrequired

Details of the filter used in this query.

element string[]required

The multicast query element ID.

remote_site string[]required

The multicast query remote site ID.

site string[]required

The multicast query site ID.

name string

The name of the multicast query. Maz size = 128.

object_type stringrequired

Possible values: [MulticastWANTrafficStatistics, MulticastWANPIMStatistics, MulticastWANPathStatistics]

The type of multicast for the query.

start_time date

The end time of the multicast statistics query.

Responses

200

Successful Operation

application/json

Schema

Schema

oneOf

MulticastWANPathStatsResponse

data MulticastWANPathStatsData

The multicast WAN path statistics.

end_time string

The end time of the multicast statistics query.

remote_site_id string

Remote Site Id

start_time string

The end time of the multicast statistics query.

wanpath_list MulticastWANPathStats[]

The information of the WAN path.

Array [

rx_bytes int64

Indicates the volume of multicast traffic received in bytes at the device interface.

rx_packets int64

Indicates the number of multicast traffic packets received at the device interface.

tx_bytes int64

Indicates the multicast traffic in terms of bytes transmitted from the device interface.

tx_packets int64

Indicates the number of multicast traffic packets transmitted from the device interface.

wanpath string

The WAN path of the outgoing interface.

]

MulticastWANPIMStatsResponse

data MulticastWANPIMStatsData

The multicast WAN PIM statistics.

end_time string

The end time of the multicast statistics query.

pim_assert_rx_pkts int64

The number of packets received for Assert messages.

pim_assert_tx_pkts int64

The number of packets transmitted for Assert messages.

pim_bsm_rx_pkts int64

The number of packets received for Bootstrap messages.

pim_bsm_tx_pkts int64

The number of packets transmitted for Bootstrap messages.

pim_hello_rx_pkts int64

The packets received for a PIM Hello message.

pim_hello_tx_pkts int64

The packets sent for a PIM Hello message.

pim_join_prune_rx_pkts int64

The join and prune packets received for a PIM Join/Prune message.

pim_join_prune_tx_pkts int64

The join and prune packets sent for a PIM Join/Prune message.

pim_register_rx_pkts int64

The packets received for a PIM Register message.

pim_register_stop_rx_pkts int64

The packets received for a PIM Register Stop message.

pim_register_stop_tx_pkts int64

The packets sent for a PIM Register Stop message.

pim_register_tx_pkts int64

The packets sent for a PIM Register message.

remote_site_id string

The multicast query remote site ID.

start_time string

The end time of the multicast statistics query.

MulticastWANTrafficStatsResponse

data MulticastWANTrafficStatsData

The multicast WAN traffic statistics.

end_time string

The end time of the multicast statistics query.

remote_site_id string

The multicast query remote site ID.

rx_bytes int64

Indicates the volume of multicast traffic received in bytes at the interface.

rx_packets int64

Indicates the number of multicast traffic packets received at the interface.

start_time string

Start Time

tx_bytes int64

Indicates the multicast traffic in terms of bytes transmitted from the interface.

tx_packets int64

Indicates the number of multicast traffic packets transmitted from the interface.

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "MULTICAST_WAN_NEIGHBOR_QUERY_MISSING_OBJECT_TYPE"
      },
      {
        "code": "MULTICAST_WAN_NEIGHBOR_QUERY_MISSING_REMOTE_SITE_ID"
      },
      {
        "code": "MULTICAST_WAN_NEIGHBOR_QUERY_INVALID_REMOTE_SITE_ID"
      },
      {
        "code": "MULTICAST_QUERY_MISSING_FILTER"
      },
      {
        "code": "MULTICAST_QUERY_MISSING_ELEMENT_ID"
      },
      {
        "code": "MULTICAST_QUERY_INVALID_ELEMENT_ID"
      },
      {
        "code": "MULTICAST_QUERY_MISSING_SITE_ID"
      },
      {
        "code": "MULTICAST_QUERY_INVALID_SITE_ID"
      }
    ]
  }
}

Loading...