Query Prefix Set (3.1)

POST 
/v3.1/api/tenants/:tenant_id/prefixes/query

Query the prefix set.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Query Details for prefixes

aggregate Aggregate

The aggregate number of prefix sets 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.

ge integer
getDeleted boolean

The number prefix sets deleted for a time frame.

group_by string[]

Group the prefix sets for the query.

id string

List the prefix sets by ID.

ipv4_prefix string

Ipv4 Prefix

ipv6_prefix string

Ipv6 Prefix

last_query_ts int64

Return the ID of a specified query in the current session.

le integer
limit int32

The query limit.

next_query object

The limit.

query_params object

Query using query parameters.

retrieved_fields string[]

Retrieve information from a field.

retrieved_fields_mask boolean

List the fields to query.

sort_params object

Specify the order in which you want the search criteria to display.

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.

tenant_id string

The tenant ID.

total_count int64

Total number.

items PrefixQueryFilterV3N1[]
Array [
element_id string
The element ID.
ipv4_prefix string
The IPv4 address prefix.
ipv6_prefix string
The IPv6 address prefix.
resource_id string
The resource ID.
resource_type string
Possible values: [static_route, interface, lan_network, BGP]
The resource type.
scope string
Possible values: [GLOBAL, LOCAL]
The prefix scope.
site_id stringrequired
The site ID.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "element_id": "string",
      "ipv4_prefix": "string",
      "ipv6_prefix": "string",
      "resource_id": "string",
      "resource_type": "static_route",
      "scope": "GLOBAL",
      "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": "BAD_QUERY_REQUEST"
      }
    ]
  }
}

Loading...