honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/autoscaling/apis/get-autoscaling-decision.as...

53 lines
1.3 KiB
Plaintext
Raw Normal View History

Add autoscaling API skelton (#51564) The main purpose of this commit is to add a single autoscaling REST endpoint skeleton, for the purpose of starting to build out the build and testing infrastructure that will surround it. For example, rather than commiting a fully-functioning autoscaling API, we introduce here the skeleton so that we can start wiring up the build and testing infrastructure, establish security roles/permissions, an so on. This way, in a forthcoming PR that introduces actual functionality, that PR will be smaller and have less distractions around that sort of infrastructure.
2020-02-06 21:55:01 -05:00
[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]
--------------------------------------------------
{
Introduce autoscaling decisions (#53934) 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.
2020-03-23 22:53:51 -04:00
decisions: []
Add autoscaling API skelton (#51564) The main purpose of this commit is to add a single autoscaling REST endpoint skeleton, for the purpose of starting to build out the build and testing infrastructure that will surround it. For example, rather than commiting a fully-functioning autoscaling API, we introduce here the skeleton so that we can start wiring up the build and testing infrastructure, establish security roles/permissions, an so on. This way, in a forthcoming PR that introduces actual functionality, that PR will be smaller and have less distractions around that sort of infrastructure.
2020-02-06 21:55:01 -05:00
}
--------------------------------------------------