Query DB for Route Maps (v2.3)
POST/sdwan/v2.3/api/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
The ID of the site.
The ID of the element.
- application/json
Body
Query details for route maps
- Array [
- ]
aggregate Aggregate
The aggregate number of route maps that match the query parameters.
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
The field value.
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
The operator values.
The aggregate statistics.
The unit.
The destination page.
The number of route maps deleted for a time frame.
Group the route maps for the query.
Lists the route maps by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Retrieve information from a field.
List the fields to query.
The total number of query parameters.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
Total number.
items RoutingRouteMapQueryFilterV2N3[]
The value true or false for auto-generated route map for an element.
The description of the route map. Max size = 1024.
The ID of the route map.
The name of the route map. Max size = 128.
route_map_entries RoutingRouteMapEntryV2N3[]
The details of the route map entries.
To continue to use the rule that the route matches.
match RoutingRouteMapEntryMatchClause
The details of route match.
As Path Id
Community List Id
Ip Next Hop Id
Ip Prefix List Id
Metric
Tag
Enter an order number from 1 to 65535 to define the order in which this route map will be used.
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
As Path Prepend
Community
Ip Next Hop
Ip V6 Next Hop
Local Preference
Metric
Tag
Possible values: [type-1
, type-2
]
Type
Weight
A information field that can be added to identify the route map. Maximum 10 unique tags of length 1024 each are allowed.
Possible values: [bgp
, ospf
]
Routing used for BGP or OSPF.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"total_count": 0,
"items": [
{
"auto_generated": true,
"id": "string",
"name": "string",
"route_map_entries": [
{
"continue_entry": "string",
"match": {
"as_path_id": "string",
"community_list_id": "string",
"ip_next_hop_id": "string",
"ip_prefix_list_id": "string",
"metric": 0,
"tag": 0
},
"order": 0,
"permit": true,
"set": {
"additive_community": true,
"as_path_prepend": "string",
"community": "string",
"ip_next_hop": "string",
"ip_v6_next_hop": "string",
"local_preference": 0,
"metric": 0,
"tag": 0,
"type": "type-1",
"weight": 0
}
}
],
"tags": [
"string"
],
"used_for": "bgp"
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "BAD_REQUEST"
},
{
"code": "ELEMENT_NOT_ASSIGNED_TO_SITE"
}
]
}
}