Create or update autoscaling policy API

edit

Create or update autoscaling policy API

edit

Autoscaling is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

Creates or updates an autoscaling policy.

Request

edit
PUT /_autoscaling/policy/<name>
{
  "roles": [],
  "deciders": {
    "fixed": {
    }
  }
}

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have manage_autoscaling cluster privileges. For more information, see Security privileges.

Description

edit

This API puts an autoscaling policy with the provided name. See Autoscaling Deciders for available deciders.

Examples

edit

This example puts an autoscaling policy named my_autoscaling_policy using the fixed autoscaling decider, applying to the set of nodes having (only) the "data_hot" role.

PUT /_autoscaling/policy/my_autoscaling_policy
{
  "roles" : [ "data_hot" ],
  "deciders": {
    "fixed": {
    }
  }
}

The API returns the following result:

{
  "acknowledged": true
}