Query Multicast IGMP Group Membership (v2.0)

POST 
/sdwan/v2.0/api/multicastigmpmemberships/query

Query multicast IGMP group membership information.

Request

application/json

Body

aggregate Aggregate

The aggregate number of multicast IGMP memberships that match the query parameters.

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

The field value.

name string

The name of the query response.

operator string

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

The operator values.

statistic string

The aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number multicast IGMP memberships deleted for a time frame.

group_by string[]

Group By

id string

List the multicast IGMP memberships 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.

total_count int64

Total number.

items MulticastIgmpMembershipQueryFilter[]
Array [
element_id string
The element ID.
id string
The multicast igmp membership ID.
igmp_group_members MulticastIgmpGroupMember[]
Details of the igmp group members.
Array [
fwd string
Indicates if the multicast information should be forwarded to the receiver in the LAN network.
group string
The multicast group from which hosts want to receive multicast information.
source string
Displays information about the hosts in the LAN network interested in receiving information from a specific multicast group.
timeout string
Indicates the period within which the ION device determines if there are receivers interested in receiving multicast traffic for a specific multicast group.
uptime string
The period for which the host has been a part of the multicast group.
]
interface_id string
The interface ID on which multicast is configured.
name string
Details of the igmp group members.
site_id stringrequired
The ID of the site.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "total_count": 0,
  "items": [
    {
      "element_id": "string",
      "id": "string",
      "igmp_group_members": [
        {
          "fwd": "string",
          "group": "string",
          "source": "string",
          "timeout": "string",
          "uptime": "string"
        }
      ],
      "interface_id": "string",
      "name": "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...