Query WAN Neighbor Statistics (v2.0)
Query all the WAN neighbor statistics.
- application/json
Request Body
Details of object stats query
- end_time date required
The end time of the multicast statistics query.
filter MulticastWANNeighborStatsFilter required
Details of the filter used in this query.
element string[] requiredThe multicast query element ID.
remote_site string[] requiredThe multicast query remote site ID.
site string[] requiredThe multicast query site ID.
- name string required
The name of the multicast query. Maz size = 128.
- object_type string required
Possible values: [
MulticastWANTrafficStatistics
,MulticastWANPIMStatistics
,MulticastWANPathStatistics
]The type of multicast for the query.
- start_time date required
The end time of the multicast statistics query.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- oneOf
- MulticastWANPathStatsResponse
- MulticastWANPIMStatsResponse
- MulticastWANTrafficStatsResponse
data MulticastWANPathStatsData required
The multicast WAN path statistics.
end_time string requiredThe end time of the multicast statistics query.
remote_site_id string requiredRemote Site Id
start_time string requiredThe end time of the multicast statistics query.
wanpath_list MulticastWANPathStats[] required
The information of the WAN path.
Array [rx_bytes int64 requiredIndicates the volume of multicast traffic received in bytes at the device interface.
rx_packets int64 requiredIndicates the number of multicast traffic packets received at the device interface.
tx_bytes int64 requiredIndicates the multicast traffic in terms of bytes transmitted from the device interface.
tx_packets int64 requiredIndicates the number of multicast traffic packets transmitted from the device interface.
wanpath string requiredThe WAN path of the outgoing interface.
]data MulticastWANPIMStatsData required
The multicast WAN PIM statistics.
end_time string requiredThe end time of the multicast statistics query.
pim_assert_rx_pkts int64 requiredThe number of packets received for Assert messages.
pim_assert_tx_pkts int64 requiredThe number of packets transmitted for Assert messages.
pim_bsm_rx_pkts int64 requiredThe number of packets received for Bootstrap messages.
pim_bsm_tx_pkts int64 requiredThe number of packets transmitted for Bootstrap messages.
pim_hello_rx_pkts int64 requiredThe packets received for a PIM Hello message.
pim_hello_tx_pkts int64 requiredThe packets sent for a PIM Hello message.
pim_join_prune_rx_pkts int64 requiredThe join and prune packets received for a PIM Join/Prune message.
pim_join_prune_tx_pkts int64 requiredThe join and prune packets sent for a PIM Join/Prune message.
pim_register_rx_pkts int64 requiredThe packets received for a PIM Register message.
pim_register_stop_rx_pkts int64 requiredThe packets received for a PIM Register Stop message.
pim_register_stop_tx_pkts int64 requiredThe packets sent for a PIM Register Stop message.
pim_register_tx_pkts int64 requiredThe packets sent for a PIM Register message.
remote_site_id string requiredThe multicast query remote site ID.
start_time string requiredThe end time of the multicast statistics query.
data MulticastWANTrafficStatsData required
The multicast WAN traffic statistics.
end_time string requiredThe end time of the multicast statistics query.
remote_site_id string requiredThe multicast query remote site ID.
rx_bytes int64 requiredIndicates the volume of multicast traffic received in bytes at the interface.
rx_packets int64 requiredIndicates the number of multicast traffic packets received at the interface.
start_time string requiredStart Time
tx_bytes int64 requiredIndicates the multicast traffic in terms of bytes transmitted from the interface.
tx_packets int64 requiredIndicates the number of multicast traffic packets transmitted from the interface.
{
"data": {
"end_time": "string",
"remote_site_id": "string",
"start_time": "string",
"wanpath_list": [
{
"rx_bytes": 0,
"rx_packets": 0,
"tx_bytes": 0,
"tx_packets": 0,
"wanpath": "string"
}
]
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"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"
}
]
}
}