Query AnynetLink Correlation Events (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/anynetlinks/correlationevents/query

Query AnynetLink correlation events.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

aggregate Aggregate

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

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 anynet links deleted for a time frame.

group_by string[]

Group By

id string

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

tenant_id string

The tenant ID.

total_count int64

Total number.

items AnynetLinkQueryFilter[]
Array [
admin_up boolean
Admin Up
ep1_site_id string
Ep1 Site Id
ep1_site_role string
Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]
Ep1 Site Role
ep1_wan_interface_id string
Ep1 Wan Interface Id
ep2_site_id string
Ep2 Site Id
ep2_site_role string
Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]
Ep2 Site Role
ep2_wan_interface_id string
Ep2 Wan Interface Id
events AnynetlinkEventState[]
Events
Array [
error_vpnlinks string[]
Error Vpnlinks
event_code string
Event Code
event_id string
Event Id
id string
Id
priority int32
Priority
site_ids string[]
Site Ids
standing boolean
Standing
suppressed boolean
Suppressed
suppressed_info SuppressedInfo
Suppressed Info
root_cause_event_ids string[]
The event IDs of the root causes.
suppressed_time date
The suppressed event time.
timestamp int64
Timestamp
]
id string
Id
type string
Possible values: [AUTO, MANUAL, AUTO_PRIVATE, MANUAL_PRIVATE, AUTO_SASE]
Type
vpn_events VPNEndpointEventState[]
Vpn Events
Array [
al_id string
Al Id
eid string
Eid
event_code string
Event Code
event_id string
Event Id
id string
Id
priority int32
Priority
site_id string
Site Id
standing boolean
Standing
suppressed boolean
Suppressed
suppressed_info SuppressedInfo
Suppressed Info
root_cause_event_ids string[]
The event IDs of the root causes.
suppressed_time date
The suppressed event time.
timestamp int64
Timestamp
vep_id string
Vep Id
vpnlink_id string
Vpnlink Id
]
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "admin_up": true,
      "ep1_site_id": "string",
      "ep1_site_role": "NONE",
      "ep1_wan_interface_id": "string",
      "ep2_site_id": "string",
      "ep2_site_role": "NONE",
      "ep2_wan_interface_id": "string",
      "events": [
        {
          "error_vpnlinks": [
            "string"
          ],
          "event_code": "string",
          "event_id": "string",
          "id": "string",
          "priority": 0,
          "site_ids": [
            "string"
          ],
          "standing": true,
          "suppressed": true,
          "suppressed_info": {
            "root_cause_event_ids": [
              "string"
            ],
            "suppressed_time": "2024-07-29"
          },
          "timestamp": 0
        }
      ],
      "id": "string",
      "type": "AUTO",
      "vpn_events": [
        {
          "al_id": "string",
          "eid": "string",
          "event_code": "string",
          "event_id": "string",
          "id": "string",
          "priority": 0,
          "site_id": "string",
          "standing": true,
          "suppressed": true,
          "suppressed_info": {
            "root_cause_event_ids": [
              "string"
            ],
            "suppressed_time": "2024-07-29"
          },
          "timestamp": 0,
          "vep_id": "string",
          "vpnlink_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...