Query Multicast Statistics (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/monitor/aggregates/multicast/mroute

Query all the multicast statistics.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Details of object stats query

end_time date

The end time of the multicast statistics query.

filter MulticastRouteStatsFilterrequired

Details of the filter used in this query.

element string[]required

The multicast query element ID.

group string[]

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 booleanrequired

The Active RP for the multicast.

name string

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

start_time date

The end time of the multicast statistics query.

type stringrequired

Possible values: [WAN, LAN]

The type of multicast for the query.

Responses

200

Successful Operation

application/json

Schema

Schema

oneOf

MulticastRouteSourceGroupStatsResponse

end_time string

The end time of the multicast statistics query.

source_group_list MulticastRouteSourceGroupStatsData[]

The details of the source group.

Array [

flags string

Flags for the multicast route table.

group string

The multicast query group IP address.

incoming_interface MulticastRouteIncomingInterface

The interface on which multicast traffic is received.

iif string

iif

is_site_interface boolean

The site interface of the multicast route.

wanpath string

The WAN path of the incoming interface.

outgoing_interfaces MulticastRouteOutgoingInterface[]

The interface on which multicast traffic is sent.

Array [

is_site_interface boolean

The site interface of the multicast route.

oif string

oif

wanpaths string[]

Wanpaths

]

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.

source string

The multicast query source IP address.

]

start_time string

The end time of the multicast statistics query.

MulticastRouteOutgoingInterfaceStatsResponse

end_time string

End Time

oif_list MulticastRouteOutgoingInterfaceStatsData[]

Oif List

Array [

is_site_interface boolean

Is Site Interface

oif string

Oif

wanpaths MulticastRouteWanpathStatsData[]

Wanpaths

Array [

last_active date

tx_bytes int64

Tx Bytes

tx_packets int64

Tx Packets

wanpath string

Wanpath

]

]

start_time string

Start Time

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_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"
      }
    ]
  }
}

Loading...