Query Element Correlation Events (v2.0)

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

Query element correlation events.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

aggregate Aggregate

Aggregate

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.

description

The description of the element.

dest_page int32

Dest Page

getDeleted boolean

GetDeleted

group_by string[]

Group By

id string

Id

last_query_ts int64

Last Query Ts

limit int32

Limit

next_query object
query_params object
retrieved_fields string[]

Retrieved Fields

retrieved_fields_mask boolean

Retrieved Fields Mask

sort_params object
total_count int64

Total Count

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 ElementQueryFilter[]
Array [
admin_action string
Possible values: [ALLOCATE, CLAIM, BOUND, UNBOUND, DECLAIM, RETURN, REVOKE, RETIRE, STOCK, UPGRADE, REMANUFACTURE, DEFAULT, INVALID]
The values of admin actions that can be performed.
allowed_roles string[]
Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]
The allowed roles.
cluster_insertion_mode string
The element ID.
cluster_member_id string
The cluster member ID.
connected boolean
The element is connected. True or False.
deployment_op string
Possible values: [DECLAIM, UPGRADE, ABORT_UPGRADE, DEFAULT, INVALID, REBIND, READY, IN_SERVICE, REUNBIND, RENEW_CIC, ABORT_CELLULARMODULE_FIRMWARE_UPGRADE, FIPS_AUTO, NON_FIPS_AUTO, FIPS_MANUAL, NON_FIPS_MANUAL, GET_MAC_ADDRESS_TABLE]
The deployment values.
description
The description of the element. Max length = 256.
events BaseEventState[]
The details of the events occurred.
Array [
event_code string
The event code.
event_id string
The event ID.
id string
Id
priority int32
The priority set for the event.
standing boolean
The standing event. True or False.
suppressed boolean
The events are suppressed. True or False.
suppressed_info SuppressedInfo
The information on the suppressed events.
root_cause_event_ids string[]
The event IDs of the root causes.
suppressed_time date
The suppressed event time.
timestamp int64
The time stamp of the event.
]
hw_id string
The hardware ID.
id string
Id
model_name string
The model name of the device.
name string
The name of the element. Max length = 128.
role string
Possible values: [PA_WE_DC, PA_WE_BR, NONE, PA_CONN, SPOKE, HUB]
The element role.
serial_number string
The serial number.
site_id stringrequired
The site ID.
software_version string
The software version.
spoke_cluster_status string
Possible values: [init, active, backup, unknown]
The spoke cluster status.
state string
Possible values: [ACTIVE_INIT, ACTIVE_INVENTORY_IN_PROGRESS, ACTIVE_INVENTORY_OPERATION_FAILED, ACTIVE_INVENTORY_GET_PENDING, ACTIVE_INVENTORY_GET_COMPLETE, ACTIVE_INVENTORY_POST_PENDING, ACTIVE_INTF_CONFIG_GET_FAILED, ACTIVE_INTF_STATE_GET_FAILED, ACTIVE_READY, ACTIVE_BOUND_IN_PROGRESS, ACTIVE_UNBOUND_IN_PROGRESS, ACTIVE_UNBOUND_FROM_SITE_FAILED, ACTIVE_BOUND_TO_SITE, ACTIVE_BOUND_TO_SITE_FAILED, OOS, ACTIVE_DECLAIM_IN_PROGRESS, ACTIVE_DECLAIMED]
The element state.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "admin_action": "ALLOCATE",
      "allowed_roles": [
        "NONE"
      ],
      "cluster_insertion_mode": "string",
      "cluster_member_id": "string",
      "connected": true,
      "deployment_op": "DECLAIM",
      "events": [
        {
          "event_code": "string",
          "event_id": "string",
          "id": "string",
          "priority": 0,
          "standing": true,
          "suppressed": true,
          "suppressed_info": {
            "root_cause_event_ids": [
              "string"
            ],
            "suppressed_time": "2024-07-29"
          },
          "timestamp": 0
        }
      ],
      "hw_id": "string",
      "id": "string",
      "model_name": "string",
      "name": "string",
      "role": "PA_WE_DC",
      "serial_number": "string",
      "site_id": "string",
      "software_version": "string",
      "spoke_cluster_status": "init",
      "state": "ACTIVE_INIT"
    }
  ]
}

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...