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[] 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 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.

Responses

Successful Operation

application/json

Schema
Example (from schema)

Schema

oneOf
- MulticastWANPathStatsResponse
- MulticastWANPIMStatsResponse
- MulticastWANTrafficStatsResponse
data MulticastWANPathStatsData required
The multicast WAN path statistics.
end_time string required
The end time of the multicast statistics query.
remote_site_id string required
Remote Site Id
start_time string required
The end time of the multicast statistics query.
wanpath_list MulticastWANPathStats[] required
The information of the WAN path.
Array [
rx_bytes int64 required
Indicates the volume of multicast traffic received in bytes at the device interface.
rx_packets int64 required
Indicates the number of multicast traffic packets received at the device interface.
tx_bytes int64 required
Indicates the multicast traffic in terms of bytes transmitted from the device interface.
tx_packets int64 required
Indicates the number of multicast traffic packets transmitted from the device interface.
wanpath string required
The WAN path of the outgoing 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 string
message 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"
      }
    ]
  }
}

Query WAN Neighbor Statistics (v2.0)​

Query WAN Neighbor Statistics (v2.0)