You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Create or update autoscaling policy APIedit
This feature 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.
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_autoscaling
cluster privilege to use this API. - If the operator privileges feature is enabled, only operator users can use this API.
Descriptionedit
This API puts an autoscaling policy with the provided name. See Autoscaling Deciders for available deciders.
Query parametersedit
-
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout. -
timeout
-
(Optional, time units)
Period to wait for a response from all relevant nodes in the cluster after
updating the cluster metadata. If no response is received before the timeout
expires, the cluster metadata update still applies but the response will
indicate that it was not completely acknowledged. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout.
Examplesedit
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 }