Skip to main content

Query Interface Correlation Events (v2.0)

POST 

/v2.0/api/tenants/:tenant_id/interfaces/correlationevents/query

Query interface correlation events.

Request

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

Body

    aggregate Aggregate

    The aggregate number of interfaces 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

    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 interfaces deleted for a time frame.

    group_by string[]

    Group By

    id string

    List the interfaces 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

Successful Operation

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 InterfaceQueryFilter[]
  • Array [
  • admin_up boolean

    The interface admin state.

    bound_interfaces string[]

    The bound interfaces.

    element_id string

    The element ID.

    events BaseEventState[]

    The details of the events occurred.

  • Array [
  • event_code string

    The event code.

    event_id string

    The event ID.

    id string

    Id

    priority int32

    The priority set for the event.

    standing boolean

    The standing event. True or False.

    suppressed boolean

    The events are suppressed. True or False.

    suppressed_info SuppressedInfo

    The information on the suppressed events.

    root_cause_event_ids string[]

    The event IDs of the root causes.

    suppressed_time date

    The suppressed event time.

    timestamp int64

    The time stamp of the event.

  • ]
  • id string

    The interface ID.

    ipv4_addresses string[]

    The IPv4 addresses configured for the interface.

    name string

    The name of the interface.

    parent string

    The parent interface.

    site_wan_interface_ids string[]

    The site WAN interface IDs.

    type string

    Possible values: [SERVICE_LINK, LOOPBACK, BYPASSPAIR, SUBINTERFACE, PPPOE, PORTCHANNEL, PORT, VIRTUAL_INTERFACE, CELLULAR]

    The interface type.

    used_for string

    Possible values: [NONE, PUBLIC, PRIVATE, LAN, PRIVATE_L2, PRIVATE_WAN]

    The value of where the interface is used.

  • ]
Loading...