Skip to main content

Query DB for Site WAN Interfaces (v2.5)

POST 

/v2.5/api/tenants/:tenant_id/sites/:site_id/waninterfaces/query

Queries the DB for Site WAN Interfaces that match the query parameters.

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

    site_id stringrequired

    ID of the site. More details on the site can be retrieved by querying the sites API.

Body

    aggregate Aggregate

    The aggregate number of WAN interfaces that match the query parameters.

    data AggregateData[]required

    The details of the aggregate data.

  • Array [
  • value numberrequired

    Value of the aggregate data.

    view objectrequired

    View the aggregate date.

  • ]
  • field string

    Field

    name stringrequired

    The name of the query response.

    operator string

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

    Operator

    statistic stringrequired

    QoS application aggregate statistics.

    unit stringrequired

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number WAN interfaces deleted for a time frame.

    group_by string[]

    Group By

    id string

    List the WAN 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 count of the query list.

    deleted_count int64

    The deleted number of queries.

    deleted_ids string[]

    The deleted query 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 of queries.

    items WANInterfaceQuery[]
  • Array [
  • aggregate Aggregate

    The aggregate number of WAN interfaces that match the query parameters.

    data AggregateData[]required

    The details of the aggregate data.

  • Array [
  • value numberrequired

    Value of the aggregate data.

    view objectrequired

    View the aggregate date.

  • ]
  • field string

    Field

    name stringrequired

    The name of the query response.

    operator string

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

    Operator

    statistic stringrequired

    QoS application aggregate statistics.

    unit stringrequired

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number WAN interfaces deleted for a time frame.

    group_by string[]

    Group By

    id string

    List the WAN 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.

  • ]
Loading...