mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 21:18:31 +00:00
e3ca124537
This is the first in a series of commits that will introduce the autoscaling deciders framework. This commit introduces the basic framework for representing autoscaling decisions.
53 lines
1.3 KiB
Plaintext
53 lines
1.3 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[autoscaling-get-autoscaling-decision]]
|
|
=== Get autoscaling decision API
|
|
++++
|
|
<titleabbrev>Get autoscaling decision</titleabbrev>
|
|
++++
|
|
|
|
Get autoscaling decision.
|
|
|
|
[[autoscaling-get-autoscaling-decision-request]]
|
|
==== {api-request-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_autoscaling/decision/
|
|
--------------------------------------------------
|
|
// TEST
|
|
|
|
[[autoscaling-get-autoscaling-decision-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have
|
|
`manage_autoscaling` cluster privileges. For more information, see
|
|
<<security-privileges>>.
|
|
|
|
[[autoscaling-get-autoscaling-decision-desc]]
|
|
==== {api-description-title}
|
|
|
|
This API gets the current autoscaling decision based on the configured
|
|
autoscaling policy. This API will return whether or not autoscaling is
|
|
needed.
|
|
|
|
[[autoscaling-get-autoscaling-decision-examples]]
|
|
==== {api-examples-title}
|
|
|
|
This example retrieves the current autoscaling decision.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_autoscaling/decision
|
|
--------------------------------------------------
|
|
// TEST
|
|
|
|
The API returns the following result:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
decisions: []
|
|
}
|
|
--------------------------------------------------
|