Get an autoscaling policy | Elasticsearch API documentation

Get an autoscaling policy Generally available; Added in 7.11.0

GET /_autoscaling/policy/{name}

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

External documentation

Path parameters

name string Required

the name of the autoscaling policy

Query parameters

master_timeout string

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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- roles array[string] Required
- deciders object Required
  
  Decider settings.
  
  External documentation
  
  Hide deciders attribute Show deciders attribute object
  
  * object Additional properties

GET /_autoscaling/policy/{name}

GET /_autoscaling/policy/my_autoscaling_policy

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

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

response = client.autoscaling.get_autoscaling_policy(
  name: "my_autoscaling_policy"
)

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

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

Response examples (200)

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

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