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

Get autoscaling policy.

Request

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

Examples

edit

This example gets an autoscaling policy named my_autoscaling_policy.

GET /_autoscaling/policy/my_autoscaling_policy

The API returns the following result:

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