Query Multicast Statistics (v2.0)

Query all the multicast statistics.

application/json

Request Body

Details of object stats query

end_time date required
The end time of the multicast statistics query.
filter MulticastRouteStatsFilter required
Details of the filter used in this query.
element string[] required
The multicast query element ID.
group string[] required
The multicast query group IP address.
site string[] required
The multicast query site ID.
source string[] required
The multicast query source IP address.
is_active boolean required
The Active RP for the multicast.
name string required
The name of the multicast query. Maz size = 128.
start_time date required
The end time of the multicast statistics query.
type string required
Possible values: [WAN, LAN]
The type of multicast for the query.

Responses

Successful Operation

application/json

Schema
Example (from schema)

Schema

oneOf
- MulticastRouteSourceGroupStatsResponse
- MulticastRouteOutgoingInterfaceStatsResponse
end_time string required
The end time of the multicast statistics query.
source_group_list MulticastRouteSourceGroupStatsData[] required
The details of the source group.
Array [
flags string required
Flags for the multicast route table.
group string required
The multicast query group IP address.
incoming_interface MulticastRouteIncomingInterface required
The interface on which multicast traffic is received.
iif string required
iif
is_site_interface boolean required
The site interface of the multicast route.
wanpath string required
The WAN path of the incoming interface.
outgoing_interfaces MulticastRouteOutgoingInterface[] required
The interface on which multicast traffic is sent.
Array [
is_site_interface boolean required
The site interface of the multicast route.
oif string required
oif
wanpaths string[] required
Wanpaths
]
rx_bytes int64 required
Indicates the volume of multicast traffic received in bytes at the interface.
rx_packets int64 required
Indicates the number of multicast traffic packets received at the interface.
source string required
The multicast query source IP address.
]
start_time string required
The end time of the multicast statistics query.

{
  "end_time": "string",
  "source_group_list": [
    {
      "flags": "string",
      "group": "string",
      "incoming_interface": {
        "iif": "string",
        "is_site_interface": true,
        "wanpath": "string"
      },
      "outgoing_interfaces": [
        {
          "is_site_interface": true,
          "oif": "string",
          "wanpaths": [
            "string"
          ]
        }
      ],
      "rx_bytes": 0,
      "rx_packets": 0,
      "source": "string"
    }
  ],
  "start_time": "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_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"
      },
      {
        "code": "MULTICAST_MROUTE_QUERY_MISSING_IS_ACTIVE"
      },
      {
        "code": "MULTICAST_MROUTE_QUERY_INVALID_SOURCE_IP"
      },
      {
        "code": "MULTICAST_MROUTE_QUERY_INVALID_GROUP_IP"
      },
      {
        "code": "MULTICAST_MROUTE_QUERY_UNSUPPORTED_TIME_FIELDS"
      },
      {
        "code": "MULTICAST_MROUTE_QUERY_MISSING_SOURCE_OR_GROUP"
      },
      {
        "code": "MULTICAST_MROUTE_QUERY_MISSING_TYPE"
      }
    ]
  }
}

Query Multicast Statistics (v2.0)​

Query Multicast Statistics (v2.0)