classes¶
Overview¶
API to get reports for classes (bandwidth is in Kbps and data is in KB)
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP
Tags¶
- classes : Operations related to classes
Paths¶
Get operation for classes¶
GET /classes
Description¶
Use this operation to get a report for classes. The response payload also contains the meta_data block.
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_name¶
The class name
Type : string
class_type¶
Class type (control, real-time, interact or bulk)
Type : string
classes_delete_success_schema¶
| Name | Schema |
|---|---|
| classes optional |
classes |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
classes_post_success_schema¶
| Name | Schema |
|---|---|
| classes optional |
classes |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
classes_put_success_schema¶
| Name | Schema |
|---|---|
| classes optional |
classes |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
classes_response_schema¶
Type : < classes_response_schema > array
| Name | Schema |
|---|---|
| class_name optional |
class_name |
| class_type optional |
class_type |
| data_coverage optional |
data_coverage |
| data_dropped optional |
data_dropped |
| data_pending optional |
data_pending |
| incoming_traffic optional |
incoming_traffic |
| packets_dropped optional |
packets_dropped |
| packets_pending optional |
packets_pending |
| packets_sent optional |
packets_sent |
| percent_drop optional |
percent_drop |
| region_name optional |
region_name |
| sent_bandwidth optional |
sent_bandwidth |
| site_name optional |
site_name |
| virtual_service optional |
virtual_service |
| wait_time optional |
wait_time |
data_coverage¶
The amount, in percent of the selected time period for which there is data
Type : number
data_dropped¶
Data dropped
Type : number
data_pending¶
Data pending
Type : number
incoming_traffic¶
Incoming traffic
Type : number
packets_dropped¶
Packets dropped
Type : integer
packets_pending¶
Packets pending
Type : integer
packets_sent¶
Packets sent
Type : integer
percent_drop¶
Drop, in percent
Type : number
region_name¶
The region name
Type : string
sent_bandwidth¶
Sent bandwidth
Type : number
site_name¶
The site name
Type : string
virtual_service¶
The Virtual Path name
Type : string
wait_time¶
Wait time, in milliseconds
Type : integer