Avi ServerAutoScalePolicy Object API

##CLI## ``` - configure serverautoscalepolicy - show serverautoscalepolicy ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /serverautoscalepolicy
  2. post /serverautoscalepolicy
  3. delete /serverautoscalepolicy/{uuid}
  4. get /serverautoscalepolicy/{uuid}
  5. patch /serverautoscalepolicy/{uuid}
  6. 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ServerAutoScalePolicyApiResponse

Example data

Content-Type: application/json
{
  "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",
    "scaleout_cooldown" : 123,
    "scalein_alertconfig_refs" : [ "aeiou" ],
    "max_scalein_adjustment_step" : 123,
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "intelligent_scalein_margin" : 123,
    "min_size" : 123,
    "intelligent_scaleout_margin" : 123,
    "scaleout_alertconfig_refs" : [ "aeiou" ]
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

ServerAutoScalePolicy

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",
  "scaleout_cooldown" : 123,
  "scalein_alertconfig_refs" : [ "aeiou" ],
  "max_scalein_adjustment_step" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "intelligent_scalein_margin" : 123,
  "min_size" : 123,
  "intelligent_scaleout_margin" : 123,
  "scaleout_alertconfig_refs" : [ "aeiou" ]
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ServerAutoScalePolicy

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",
  "scaleout_cooldown" : 123,
  "scalein_alertconfig_refs" : [ "aeiou" ],
  "max_scalein_adjustment_step" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "intelligent_scalein_margin" : 123,
  "min_size" : 123,
  "intelligent_scaleout_margin" : 123,
  "scaleout_alertconfig_refs" : [ "aeiou" ]
}

Produces

This API call produces the following media types according to the Accept 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

ServerAutoScalePolicy

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",
  "scaleout_cooldown" : 123,
  "scalein_alertconfig_refs" : [ "aeiou" ],
  "max_scalein_adjustment_step" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "intelligent_scalein_margin" : 123,
  "min_size" : 123,
  "intelligent_scaleout_margin" : 123,
  "scaleout_alertconfig_refs" : [ "aeiou" ]
}

Produces

This API call produces the following media types according to the Accept 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

ServerAutoScalePolicy

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",
  "scaleout_cooldown" : 123,
  "scalein_alertconfig_refs" : [ "aeiou" ],
  "max_scalein_adjustment_step" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "intelligent_scalein_margin" : 123,
  "min_size" : 123,
  "intelligent_scaleout_margin" : 123,
  "scaleout_alertconfig_refs" : [ "aeiou" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ServerAutoScalePolicy

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. ServerAutoScalePolicy
  2. ServerAutoScalePolicyApiResponse

ServerAutoScalePolicy Up

description (optional)
String User defined description for the object.
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.
intelligent_scalein_margin (optional)
Integer Maximum extra capacity as percentage of load used by the intelligent scheme. Scalein is triggered when available capacity is more than this margin. Allowed values are 1-99. format: int32
intelligent_scaleout_margin (optional)
Integer Minimum extra capacity as percentage of load used by the intelligent scheme. Scaleout is triggered when available capacity is less than this margin. Allowed values are 1-99. format: int32
max_scalein_adjustment_step (optional)
Integer Maximum number of servers to scalein simultaneously. The actual number of servers to scalein is chosen such that target number of servers is always more than or equal to the min_size. format: int32
max_scaleout_adjustment_step (optional)
Integer Maximum number of servers to scaleout simultaneously. The actual number of servers to scaleout is chosen such that target number of servers is always less than or equal to the max_size. format: int32
max_size (optional)
Integer Maximum number of servers after scaleout. Allowed values are 0-400. format: int32
min_size (optional)
Integer No scale-in happens once number of operationally up servers reach min_servers. Allowed values are 0-400. format: int32
name
String Name of the object.
scalein_alertconfig_refs (optional)
array[String] Trigger scalein when alerts due to any of these Alert configurations are raised. It is a reference to an object of type AlertConfig.
scalein_cooldown (optional)
Integer Cooldown period during which no new scalein is triggered to allow previous scalein to successfully complete. format: int32
scaleout_alertconfig_refs (optional)
array[String] Trigger scaleout when alerts due to any of these Alert configurations are raised. It is a reference to an object of type AlertConfig.
scaleout_cooldown (optional)
Integer Cooldown period during which no new scaleout is triggered to allow previous scaleout to successfully complete. format: int32
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
use_predicted_load (optional)
Boolean Use predicted load rather than current load.
uuid (optional)
String Unique object identifier of the object.

ServerAutoScalePolicyApiResponse Up

count
Integer format: int32
results