Query Multicast Status Information (v2.0)

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

Query the multicast status information.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

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

The multicast 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 MulticastStatusQueryFilter[]
Array [
address stringrequired
The multicast status interface address.
element_id string
The element ID.
id string
The ID of the multicast config.
interface_id string
The interface ID on which multicast is configured.
name stringrequired
The name of the multicast status interface.
pim_neighbors MulticastNeighbor[]required
The PIM neighbor’s IP address.
Array [
address string
The address of the selected interface.
dr boolean
The neighbor is a designated router.
dr_prio string
The priority associated with the interface on the device for DR election.
expires string
The time remaining before a neighbor is timed out and the next PIM Hello message is received.
uptime string
The time for which the neighbor has been up.
]
site_id stringrequired
The site ID.
state stringrequired
The state of the selected interface—up or down.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "address": "string",
      "element_id": "string",
      "id": "string",
      "interface_id": "string",
      "name": "string",
      "pim_neighbors": [
        {
          "address": "string",
          "dr": true,
          "dr_prio": "string",
          "expires": "string",
          "uptime": "string"
        }
      ],
      "site_id": "string",
      "state": "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...