Query Multicast Route Table (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/multicastroutes/query

Query the multicast route table.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

aggregate Aggregate

The aggregate number of queries.

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

Field

name string

The name of the query response.

operator string

Possible values: [max, count, min, avg, sum]

Operator

statistic string

QoS application aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number of queries deleted for a time frame.

group_by string[]

Group By

id string

Group the queries by ID.

last_query_ts int64

Return the ID of a specified query in the current session.

limit int32

The query limit.

next_query object

The limit.

query_params object
retrieved_fields string[]

Retrieve information from a field.

retrieved_fields_mask boolean

List the fields to query.

sort_params object
total_count int64

The total number of query parameters.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

tenant_id string

The tenant ID.

total_count int64

Total number.

items MulticastRouteTableQueryFilter[]
Array [
element_id string
The element ID.
id string
The ID of the multicast config.
mroutes MulticastRoute[]required
Indicates how multicast traffic is routed to hosts in the network. Multicast routes are required and the number of routes should be less than 5K.
Array [
element_rp boolean
Interface or router configured as an (Rendezvous Point) RP in the network.
flags string
Flags for the multicast route table.
group string
The multicast group address.
incoming_interface string
The interface on which multicast traffic is received.
outgoing_interfaces string[]
The interfaces on which multicast traffic needs to be replicated.
rp_address string
he address of the Rendezvous Point (RP) in the network.
source string
The source address of multicast traffic in the network.
]
site_id stringrequired
The site ID.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "element_id": "string",
      "id": "string",
      "mroutes": [
        {
          "element_rp": true,
          "flags": "string",
          "group": "string",
          "incoming_interface": "string",
          "outgoing_interfaces": [
            "string"
          ],
          "rp_address": "string",
          "source": "string"
        }
      ],
      "site_id": "string"
    }
  ]
}

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

Loading...