获取自动伸缩容量 API编辑

此功能旨在供 Elasticsearch 服务Elastic Cloud EnterpriseElastic Cloud on Kubernetes 间接使用。不支持直接使用。

获取自动伸缩容量。

请求编辑

GET /_autoscaling/capacity/

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能,则您必须具有 manage_autoscaling 集群权限。有关更多信息,请参阅 安全权限

描述编辑

此 API 根据配置的自动伸缩策略获取当前自动伸缩容量。此 API 将返回信息以根据当前工作负载适当地调整集群大小。

计算 required_capacity 为所有为策略启用的单个决策器的 required_capacity 结果的最大值。

操作员应验证 current_nodes 是否与操作员对集群的了解相匹配,以避免根据陈旧或不完整的信息做出自动伸缩决策。

响应包含决策器特定信息,您可以使用这些信息来诊断自动伸缩如何以及为何确定了某个所需的容量。此信息仅用于诊断。不要使用此信息做出自动伸缩决策。

响应主体编辑

policies

(object) 包含策略名称到容量结果的映射

policies 的属性
<policy_name>

(object) 包含策略的容量信息

<policy_name> 的属性
required_capacity

(object) 包含策略的所需容量。

required_capacity 的属性
node

(object) 包含每个节点所需的最小节点大小,确保单个分片或 ML 作业可以放入单个节点中。

node 的属性
storage
(integer) 每个节点所需的存储字节数。
memory
(integer) 每个节点所需的内存字节数。
processors
(float) 每个节点所需的处理器(vCPU)数量。
total

(object) 包含策略所需的总大小。

total 的属性
storage
(integer) 策略所需的总存储字节数。
memory
(integer) 策略所需的总内存字节数。
processors
(float) 策略所需的总处理器(vCPU)数量。
current_capacity

(object) 包含受策略管理的节点的当前容量,即 Elasticsearch 基于其进行计算的节点。

current_capacity 的属性
node

(object) 包含受策略管理的节点的最大大小。

node 的属性
storage
(integer) 节点的最大存储字节数。
memory
(integer) 节点的最大内存字节数。
processors
(float) 节点的最大处理器(vCPU)数量。
total

(object) 包含受策略管理的节点的当前总存储和内存大小。

total 的属性
storage
(integer) 策略当前可用的存储字节数。
memory
(integer) 策略当前可用的内存字节数。
processors
策略当前可用的处理器(vCPU)数量。
current_nodes

(array of objects) 用于容量计算的节点列表。

current_nodes 中元素的属性
name
(string) 节点的名称。
deciders

(object) 来自单个决策器的容量结果,可以深入了解如何计算外部级别 required_capacity

deciders 的属性
<decider_name>

(object) 为策略启用的特定决策器的容量结果。

<decider_name> 的属性
required_capacity

(object) 决策器确定的所需容量。

required_capacity 的属性
node

(object) 包含每个节点所需的最小节点大小,确保单个分片或机器学习作业可以放入单个节点中。

node 的属性
storage
(integer) 每个节点所需的存储字节数。
memory
(integer) 每个节点所需的内存字节数。
processors
(float) 每个节点所需的处理器(vCPU)数量。
total

(object) 包含策略所需的总大小。

total 的属性
storage
(integer) 策略所需的总存储字节数。
memory
(integer) 策略所需的总内存字节数。
processors
(float) 策略所需的总处理器(vCPU)数量。
reason_summary
(string) 决策器结果依据的描述。
reason_details
(object) 一个针对每个决策器的结构,包含有关决策器结果依据的详细信息。内容不应依赖于应用程序目的,并且不受向后兼容性保证的约束。

示例编辑

此示例检索当前自动伸缩容量。

GET /_autoscaling/capacity

API 返回以下结果

{
  policies: {}
}