Get autoscaling policy API

edit

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

Get autoscaling policy.

Request

edit
resp = client.autoscaling.get_autoscaling_policy(
    name="<name>",
)
print(resp)
const response = await client.autoscaling.getAutoscalingPolicy({
  name: "<name>",
});
console.log(response);
GET /_autoscaling/policy/<name>

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 gets an autoscaling policy with the provided name.

Query parameters

edit
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.

Examples

edit

This example gets an autoscaling policy named my_autoscaling_policy.

resp = client.autoscaling.get_autoscaling_policy(
    name="my_autoscaling_policy",
)
print(resp)
const response = await client.autoscaling.getAutoscalingPolicy({
  name: "my_autoscaling_policy",
});
console.log(response);
GET /_autoscaling/policy/my_autoscaling_policy

The API returns the following result:

{
   "roles": <roles>,
   "deciders": <deciders>
}