Skip to content

classes

Overview

This resource provides QoS Classes statistics

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP

Tags

  • classes : Operations related to classes

Paths

Get operation for classes

GET /classes

Description

This resource provides QoS Classes statistics. Filter and Pagination are supported for this API. Refer Getting Started Guide where filtering and pagination is explained via example of application monitoring API

Responses

HTTP Code Description Schema
200 API Successfully executed classes_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • classes

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

class_object

Class Stats for each virtual Path Service

Type : < class_object > array

class_object

Name Description Schema
bandwidth
optional
read-only
Bandwidth in kbps string
class_number
optional
read-only
Class Number string
dropped_bytes
optional
read-only
Dropped Bytes string
dropped_packets
optional
read-only
Dropped Packets string
name
optional
read-only
Class Name string
pending_bytes
optional
read-only
Pending Bytes string
pending_packets
optional
read-only
Pending Packets string
sent_bytes
optional
read-only
Sent Bytes string
sent_packets
optional
read-only
Sent Packets string
type
optional
read-only
Class Type string
wait_ms
optional
read-only
Wait time in Milliseconds string

classes_delete_success_schema

Name Schema
classes
optional
classes

classes

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

classes_post_success_schema

Name Schema
classes
optional
classes

classes

Name Description Schema
message
optional
Example : "resource added succesfully" string

classes_put_success_schema

Name Schema
classes
optional
classes

classes

Name Description Schema
message
optional
Example : "resource modified succesfully" string

classes_response_schema

Type : < classes_response_schema > array

classes_response_schema

Name Schema
class_object
optional
class_object
virtual_path_service_name
optional
virtual_path_service_name

virtual_path_service_name

Name of Virtual path Service

Type : string