PATCH /serverautoscalepolicy/{uuid}

PATCH /serverautoscalepolicy/{uuid}

/serverautoscalepolicy/{uuid}

Request
URI
PATCH
https://{api_host}/api/serverautoscalepolicy/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Request Body

ServerAutoScalePolicy object creation

ServerAutoScalePolicy of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "delay_for_server_garbage_collection": 0,
    "description": "string",
    "intelligent_autoscale": false,
    "intelligent_scalein_margin": 0,
    "intelligent_scaleout_margin": 0,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "max_scalein_adjustment_step": 0,
    "max_scaleout_adjustment_step": 0,
    "max_size": 0,
    "min_size": 0,
    "name": "string",
    "scalein_alertconfig_refs": [
        "string"
    ],
    "scalein_cooldown": 0,
    "scaleout_alertconfig_refs": [
        "string"
    ],
    "scaleout_cooldown": 0,
    "scheduled_scalings": [
        {
            "autoscaling_duration": 0,
            "cron_expression": "string",
            "desired_capacity": 0,
            "enable": false,
            "end_date": "string",
            "schedule_max_step": 0,
            "start_date": "string"
        }
    ],
    "tenant_ref": "string",
    "url": "string",
    "use_predicted_load": false,
    "uuid": "string"
}
Responses
200

OK

Returns ServerAutoScalePolicy of type(s) application/json
"ServerAutoScalePolicy Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

object
configpb_attributes
Optional

configpb_attributes

integer As uint32 As uint32
delay_for_server_garbage_collection
Optional

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.

string
description
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
intelligent_autoscale
Optional

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.

integer As uint32 As uint32
intelligent_scalein_margin
Optional
Constraints: default: 40

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.

integer As uint32 As uint32
intelligent_scaleout_margin
Optional
Constraints: default: 20

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.

array of object
markers
Optional

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.

integer As uint32 As uint32
max_scalein_adjustment_step
Optional
Constraints: default: 1

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.

integer As uint32 As uint32
max_scaleout_adjustment_step
Optional
Constraints: default: 1

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.

integer As uint32 As uint32
max_size
Optional

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.

integer As uint32 As uint32
min_size
Optional

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.

string
name
Required

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
scalein_alertconfig_refs
Optional

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.

integer As uint32 As uint32
scalein_cooldown
Optional
Constraints: default: 300

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.

array of string
scaleout_alertconfig_refs
Optional

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.

integer As uint32 As uint32
scaleout_cooldown
Optional
Constraints: default: 300

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.

array of object
scheduled_scalings
Optional

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.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

boolean
use_predicted_load
Optional

Use predicted load rather than current load. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
uuid
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}'