Skip to main content

Query DB for Route Maps (v2.3)

POST 

/v2.3/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/routing_routemaps/query

Queries the DB for limit number of route maps that match the query parameters.

Request

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

    site_id stringrequired

    The ID of the site.

    element_id stringrequired

    The ID of the element.

Body

Query details for route maps

    aggregate Aggregate

    The aggregate number of route maps 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 of route maps deleted for a time frame.

    group_by string[]

    Group the route maps for the query.

    id string

    Lists the route maps 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 RoutingRouteMapQueryFilterV2N3[]
  • Array [
  • auto_generated boolean

    The value true or false for auto-generated route map for an element.

    description

    The description of the route map. Max size = 1024.

    id string

    The ID of the route map.

    name stringrequired

    The name of the route map. Max size = 128.

    route_map_entries RoutingRouteMapEntryV2N3[]

    The details of the route map entries.

  • Array [
  • continue_entry string

    To continue to use the rule that the route matches.

    match RoutingRouteMapEntryMatchClause

    The details of route match.

    as_path_id string

    As Path Id

    community_list_id string

    Community List Id

    ip_next_hop_id string

    Ip Next Hop Id

    ip_prefix_list_id string

    Ip Prefix List Id

    metric int64

    Metric

    tag int32

    Tag

    order int32

    Enter an order number from 1 to 65535 to define the order in which this route map will be used.

    permit boolean

    It allow routes to be advertised or Deny to block the routes from being advertised.

    set RoutingRouteMapEntrySetClause

    The details of the route map set.

    additive_community boolean

    Additive Community

    as_path_prepend string

    As Path Prepend

    community string

    Community

    ip_next_hop string

    Ip Next Hop

    ip_v6_next_hop string

    Ip V6 Next Hop

    local_preference int64

    Local Preference

    metric int64

    Metric

    tag int32

    Tag

    type string

    Possible values: [type-1, type-2]

    Type

    weight int64

    Weight

  • ]
  • tags string[]

    A information field that can be added to identify the route map. Maximum 10 unique tags of length 1024 each are allowed.

    used_for string

    Possible values: [bgp, ospf]

    Routing used for BGP or OSPF.

  • ]
Loading...