Query OSPF Discovered Neighbors (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/ospfdiscoveredneighbors/query

Queries the OSPF discovered neighbors that match the query parameters.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Query Details for OSPF discovered neighbors

aggregate Aggregate

The aggregate number of OSPF discovered neighbors 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 OSPF discovered neighbors deleted for a time frame.

group_by string[]

Group the OSPF discovered neighbors for the query.

id string

List the OSPF discovered neighbors 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 OspfDiscoveredNeighborFilter[]
Array [
discovered_neighbors_count integer
The number of OSPF discovered neighbors.
id string
The OSPF discovered neighbor ID.
interfaces InterfaceConfig[]
The interfaces name.
Array [
area_id integer
Identifier for the area in x.x.x.x format.
discovered_neighbors DiscoveredNeighbor[]
Info on the discovered neighbors.
Array [
neighbor_id string
The discovered neighbor ID.
status string
Status of the configuration.
]
interface_id string
Associated area interface ID.
]
ospf_config_id string
The OSPF config ID.
vrf_context_id string
The attached VRF (Virtual Routing and Forwarding) ID.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "discovered_neighbors_count": 0,
      "id": "string",
      "interfaces": [
        {
          "area_id": 0,
          "discovered_neighbors": [
            {
              "neighbor_id": "string",
              "status": "string"
            }
          ],
          "interface_id": "string"
        }
      ],
      "ospf_config_id": "string",
      "vrf_context_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": "OSPF_CONFIG_NOT_FOUND"
      }
    ]
  }
}

Loading...