virtual_path_default_set_realtime_classes¶
Overview¶
API to modify, get Virtual Path Default Set Real-Time Classes
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- virtual_path_default_set_realtime_classes : Operations related to virtual_path_default_set_realtime_classes
Paths¶
Get operation for virtual_path_default_set_realtime_classes¶
GET /virtual_path_default_set_realtime_classes
Description¶
Use this operation to get the Virtual Path Default Set Real-Time Classes
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | virtual_path_default_set_realtime_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¶
- virtual_path_default_set_realtime_classes
PUT operation for virtual_path_default_set_realtime_classes¶
PUT /virtual_path_default_set_realtime_classes
Description¶
Use this operation to modify Virtual Path Default Set Real-Time Classes
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
virtual_path_default_set_realtime_classes_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | virtual_path_default_set_realtime_classes_put_success_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 |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- virtual_path_default_set_realtime_classes
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
class_id¶
Class ID
Type : integer
initial_rate_percent¶
The maximum rate during the Initial Period, as a percentage or in kbps
Type : integer
is_auto¶
To indicate that this is auto-generated
Type : boolean
name¶
Class Name
Type : string
package_name¶
Config package name using which the API operation should be performed.
Type : string
period¶
Duration to apply the Initial Rate before switching to the Sustained Rate, in milliseconds
Type : integer
sustained_rate_percent¶
The maximum rate after the Initial Period, as a percent share of the Virtual Path or in kbps
Type : integer
type¶
Class Traffic Type
Type : string
virtual_path_default_set_name¶
Virtual path Default Set name using which the API operation should be performed.
Type : string
virtual_path_default_set_realtime_classes¶
| Name | Schema |
|---|---|
| class_id optional |
class_id |
| initial_rate_percent optional |
initial_rate_percent |
| name optional |
name |
| package_name optional |
package_name |
| period optional |
period |
| sustained_rate_percent optional |
sustained_rate_percent |
| virtual_path_default_set_name optional |
virtual_path_default_set_name |
virtual_path_default_set_realtime_classes_delete_success_schema¶
| Name | Schema |
|---|---|
| virtual_path_default_set_realtime_classes optional |
virtual_path_default_set_realtime_classes |
virtual_path_default_set_realtime_classes
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
virtual_path_default_set_realtime_classes_post_success_schema¶
| Name | Schema |
|---|---|
| virtual_path_default_set_realtime_classes optional |
virtual_path_default_set_realtime_classes |
virtual_path_default_set_realtime_classes
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
virtual_path_default_set_realtime_classes_put_success_schema¶
| Name | Schema |
|---|---|
| virtual_path_default_set_realtime_classes optional |
virtual_path_default_set_realtime_classes |
virtual_path_default_set_realtime_classes
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
virtual_path_default_set_realtime_classes_request_schema¶
| Name | Schema |
|---|---|
| virtual_path_default_set_realtime_classes optional |
virtual_path_default_set_realtime_classes |
virtual_path_default_set_realtime_classes_response_schema¶
Type : < virtual_path_default_set_realtime_classes_response_schema > array
virtual_path_default_set_realtime_classes_response_schema
| Name | Schema |
|---|---|
| class_id optional |
class_id |
| initial_rate_percent optional |
initial_rate_percent |
| is_auto optional |
is_auto |
| name optional |
name |
| package_name optional |
package_name |
| period optional |
period |
| sustained_rate_percent optional |
sustained_rate_percent |
| type optional |
type |
| virtual_path_default_set_name optional |
virtual_path_default_set_name |