Query DB for VPN Links (v2.0)

POST 
/sdwan/v2.0/api/vpnlinks/query

Query DB for VPN links that match query parameters.

Request

application/json

Body

aggregate Aggregate

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

The field value.

name string

The name of the query response.

operator string

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

The operator values.

statistic string

The aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number of VPN links deleted for a time frame.

group_by string[]

Group the VPN links for the query.

id string

Lists the VPN links 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

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.

total_count int64

Total number.

items VPNLinkQuery[]
Array [
aggregate Aggregate
The aggregate number of VPN links 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
The field value.
name string
The name of the query response.
operator string
Possible values: [max, count, min, avg, sum]
The operator values.
statistic string
The aggregate statistics.
unit string
The unit.
dest_page int32
The destination page.
getDeleted boolean
The number of VPN links deleted for a time frame.
group_by string[]
Group the VPN links for the query.
id string
Lists the VPN links 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.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "total_count": 0,
  "items": [
    {
      "aggregate": {
        "data": [
          {
            "value": 0,
            "view": {}
          }
        ],
        "field": "string",
        "name": "string",
        "operator": "max",
        "statistic": "string",
        "unit": "string"
      },
      "dest_page": 0,
      "getDeleted": true,
      "group_by": [
        "string"
      ],
      "id": "string",
      "last_query_ts": 0,
      "limit": 0,
      "next_query": {},
      "query_params": {},
      "retrieved_fields": [
        "string"
      ],
      "retrieved_fields_mask": true,
      "sort_params": {},
      "total_count": 0
    }
  ]
}

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": "VPL_NOT_FOUND"
      },
      {
        "code": "VPL_ACTION_INSUFFICIENT_VPE"
      }
    ]
  }
}

Loading...