Get an autoscaling policy

GET /_autoscaling/policy/{name}

Auth

Note

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

Read the reference documentation

Path parameters

name string required: Name of the autoscaling policy

Query parameters

master_timeout string · default: 30s: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

Response

application/json

roles string[] required
deciders map string to object required: Decider settings.; Reference

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_autoscaling/policy/my_autoscaling_policy

JavaScript Elasticsearch JavaScript Client

const response = await client.autoscaling.getAutoscalingPolicy({
  name: "my_autoscaling_policy",
});

Python Elasticsearch Python Client

resp = client.autoscaling.get_autoscaling_policy(
    name="my_autoscaling_policy",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_autoscaling/policy/my_autoscaling_policy" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.autoscaling().getAutoscalingPolicy(g -> g
    .name("my_autoscaling_policy")
);

PHP Elasticsearch PHP Client

$resp = $client->autoscaling()->getAutoscalingPolicy([
    "name" => "my_autoscaling_policy",
]);

Ruby Elasticsearch Ruby Client

response = client.perform_request(
  "GET",
  "/_autoscaling/policy/my_autoscaling_policy",
  {},
)

Response

This may be a response to GET /_autoscaling/policy/my_autoscaling_policy.

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