Avi ServerAutoScalePolicy Object API
CLI ``` - configure serverautoscalepolicy - show serverautoscalepolicy ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /serverautoscalepolicypost /serverautoscalepolicydelete /serverautoscalepolicy/{uuid}get /serverautoscalepolicy/{uuid}patch /serverautoscalepolicy/{uuid}put /serverautoscalepolicy/{uuid}
Up
get /serverautoscalepolicy
(serverautoscalepolicyGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"scalein_cooldown" : 123,
"use_predicted_load" : true,
"max_scaleout_adjustment_step" : 123,
"intelligent_autoscale" : true,
"description" : "aeiou",
"uuid" : "aeiou",
"max_size" : 123,
"url" : "aeiou",
"_last_modified" : "aeiou",
"scaleout_cooldown" : 123,
"scalein_alertconfig_refs" : [ "aeiou" ],
"max_scalein_adjustment_step" : 123,
"scheduled_scalings" : [ {
"autoscaling_duration" : 123,
"end_date" : "aeiou",
"desired_capacity" : 123,
"cron_expression" : "aeiou",
"enable" : true,
"schedule_max_step" : 123,
"start_date" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"intelligent_scalein_margin" : 123,
"min_size" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"delay_for_server_garbage_collection" : 123,
"intelligent_scaleout_margin" : 123,
"scaleout_alertconfig_refs" : [ "aeiou" ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
ServerAutoScalePolicyApiResponse
401
log in failed
Up
post /serverautoscalepolicy
(serverautoscalepolicyPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ServerAutoScalePolicy object creation
Return type
Example data
Content-Type: application/json
{
"scalein_cooldown" : 123,
"use_predicted_load" : true,
"max_scaleout_adjustment_step" : 123,
"intelligent_autoscale" : true,
"description" : "aeiou",
"uuid" : "aeiou",
"max_size" : 123,
"url" : "aeiou",
"_last_modified" : "aeiou",
"scaleout_cooldown" : 123,
"scalein_alertconfig_refs" : [ "aeiou" ],
"max_scalein_adjustment_step" : 123,
"scheduled_scalings" : [ {
"autoscaling_duration" : 123,
"end_date" : "aeiou",
"desired_capacity" : 123,
"cron_expression" : "aeiou",
"enable" : true,
"schedule_max_step" : 123,
"start_date" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"intelligent_scalein_margin" : 123,
"min_size" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"delay_for_server_garbage_collection" : 123,
"intelligent_scaleout_margin" : 123,
"scaleout_alertconfig_refs" : [ "aeiou" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
ServerAutoScalePolicy
401
log in failed
Up
delete /serverautoscalepolicy/{uuid}
(serverautoscalepolicyUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /serverautoscalepolicy/{uuid}
(serverautoscalepolicyUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"scalein_cooldown" : 123,
"use_predicted_load" : true,
"max_scaleout_adjustment_step" : 123,
"intelligent_autoscale" : true,
"description" : "aeiou",
"uuid" : "aeiou",
"max_size" : 123,
"url" : "aeiou",
"_last_modified" : "aeiou",
"scaleout_cooldown" : 123,
"scalein_alertconfig_refs" : [ "aeiou" ],
"max_scalein_adjustment_step" : 123,
"scheduled_scalings" : [ {
"autoscaling_duration" : 123,
"end_date" : "aeiou",
"desired_capacity" : 123,
"cron_expression" : "aeiou",
"enable" : true,
"schedule_max_step" : 123,
"start_date" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"intelligent_scalein_margin" : 123,
"min_size" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"delay_for_server_garbage_collection" : 123,
"intelligent_scaleout_margin" : 123,
"scaleout_alertconfig_refs" : [ "aeiou" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
ServerAutoScalePolicy
401
log in failed
Up
patch /serverautoscalepolicy/{uuid}
(serverautoscalepolicyUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ServerAutoScalePolicy object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"scalein_cooldown" : 123,
"use_predicted_load" : true,
"max_scaleout_adjustment_step" : 123,
"intelligent_autoscale" : true,
"description" : "aeiou",
"uuid" : "aeiou",
"max_size" : 123,
"url" : "aeiou",
"_last_modified" : "aeiou",
"scaleout_cooldown" : 123,
"scalein_alertconfig_refs" : [ "aeiou" ],
"max_scalein_adjustment_step" : 123,
"scheduled_scalings" : [ {
"autoscaling_duration" : 123,
"end_date" : "aeiou",
"desired_capacity" : 123,
"cron_expression" : "aeiou",
"enable" : true,
"schedule_max_step" : 123,
"start_date" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"intelligent_scalein_margin" : 123,
"min_size" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"delay_for_server_garbage_collection" : 123,
"intelligent_scaleout_margin" : 123,
"scaleout_alertconfig_refs" : [ "aeiou" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
ServerAutoScalePolicy
401
log in failed
Up
put /serverautoscalepolicy/{uuid}
(serverautoscalepolicyUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ServerAutoScalePolicy object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"scalein_cooldown" : 123,
"use_predicted_load" : true,
"max_scaleout_adjustment_step" : 123,
"intelligent_autoscale" : true,
"description" : "aeiou",
"uuid" : "aeiou",
"max_size" : 123,
"url" : "aeiou",
"_last_modified" : "aeiou",
"scaleout_cooldown" : 123,
"scalein_alertconfig_refs" : [ "aeiou" ],
"max_scalein_adjustment_step" : 123,
"scheduled_scalings" : [ {
"autoscaling_duration" : 123,
"end_date" : "aeiou",
"desired_capacity" : 123,
"cron_expression" : "aeiou",
"enable" : true,
"schedule_max_step" : 123,
"start_date" : "aeiou"
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"intelligent_scalein_margin" : 123,
"min_size" : 123,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"delay_for_server_garbage_collection" : 123,
"intelligent_scaleout_margin" : 123,
"scaleout_alertconfig_refs" : [ "aeiou" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
ServerAutoScalePolicy
401
log in failed
[ Jump to Methods ]
Table of Contents
ConfigPbAttributesKeyValueRoleFilterMatchLabelScheduledScalingServerAutoScalePolicyServerAutoScalePolicyApiResponse
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
autoscaling_duration (optional)
Integer Scheduled autoscale duration (in hours). Allowed values are 1-24. Field introduced in 21.1.1. Unit is HOURS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
cron_expression (optional)
String The cron expression describing desired time for the scheduled autoscale. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
desired_capacity (optional)
Integer Desired number of servers during scheduled intervals, it may cause scale-in or scale-out based on the value. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
enable (optional)
Boolean Enables the scheduled autoscale. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
end_date (optional)
String Scheduled autoscale end date in ISO8601 format, said day will be included in scheduled and have to be in future and greater than start date. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
schedule_max_step (optional)
Integer Maximum number of simultaneous scale-in/out servers for scheduled autoscale. If this value is 0, regular autoscale policy dictates this. . Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
start_date (optional)
String Scheduled autoscale start date in ISO8601 format, said day will be included in scheduled and have to be in future. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
delay_for_server_garbage_collection (optional)
Integer Delay in minutes after which a down server will be removed from Pool. Value 0 disables this functionality. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
description (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
intelligent_autoscale (optional)
Boolean Use Avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
intelligent_scalein_margin (optional)
Integer Maximum extra capacity as percentage of load used by the intelligent scheme. Scale-in is triggered when available capacity is more than this margin. Allowed values are 1-99. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
intelligent_scaleout_margin (optional)
Integer Minimum extra capacity as percentage of load used by the intelligent scheme. Scale-out is triggered when available capacity is less than this margin. Allowed values are 1-99. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
max_scalein_adjustment_step (optional)
Integer Maximum number of servers to scale-in simultaneously. The actual number of servers to scale-in is chosen such that target number of servers is always more than or equal to the min_size. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_scaleout_adjustment_step (optional)
Integer Maximum number of servers to scale-out simultaneously. The actual number of servers to scale-out is chosen such that target number of servers is always less than or equal to the max_size. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
max_size (optional)
Integer Maximum number of servers after scale-out. Allowed values are 0-400. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
min_size (optional)
Integer No scale-in happens once number of operationally up servers reach min_servers. Allowed values are 0-400. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
scalein_alertconfig_refs (optional)
array[String] Trigger scale-in when alerts due to any of these Alert configurations are raised. It is a reference to an object of type AlertConfig. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
scalein_cooldown (optional)
Integer Cooldown period during which no new scale-in is triggered to allow previous scale-in to successfully complete. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
scaleout_alertconfig_refs (optional)
array[String] Trigger scale-out when alerts due to any of these Alert configurations are raised. It is a reference to an object of type AlertConfig. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
scaleout_cooldown (optional)
Integer Cooldown period during which no new scale-out is triggered to allow previous scale-out to successfully complete. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
scheduled_scalings (optional)
array[ScheduledScaling] Scheduled-based scale-in/out policy. During scheduled intervals, metrics based autoscale is not enabled and number of servers will be solely derived from ScheduleScale policy. Field introduced in 21.1.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
use_predicted_load (optional)
Boolean Use predicted load rather than current load. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)