« REST API compatibility Behavioral Analytics APIs »
Elastic Docs ›Elasticsearch Guide ›REST APIs

自动扩展API

edit

自动扩展API

edit

此功能旨在供 Elasticsearch Service、Elastic Cloud Enterprise 和 Elastic Cloud on Kubernetes 间接使用。不支持直接使用。

您可以使用以下API来执行自动缩放操作。

顶级

edit

创建或更新自动扩展策略 API

edit

此功能旨在供 Elasticsearch Service、Elastic Cloud Enterprise 和 Elastic Cloud on Kubernetes 间接使用。不支持直接使用。

创建或更新一个自动缩放策略。

请求

edit
PUT /_autoscaling/policy/<name>
{
  "roles": [],
  "deciders": {
    "fixed": {
    }
  }
}

先决条件

edit
  • 如果启用了Elasticsearch安全功能，您必须拥有manage_autoscaling 集群权限才能使用此API。
  • 如果启用了操作员权限功能，则只有操作员用户可以使用此API。

描述

edit

此API使用提供的名称设置自动缩放策略。 请参阅自动缩放决策器以了解可用的决策器。

查询参数

edit
master_timeout
(可选，时间单位) 等待主节点的时间段。如果在超时到期之前主节点不可用，请求将失败并返回错误。默认为30s。 也可以设置为-1，表示请求不应超时。
timeout
(可选，时间单位) 在更新集群元数据后，等待集群中所有相关节点响应的时间段。 如果在超时到期之前未收到响应，集群元数据更新仍然适用，但响应将表明它未被完全确认。 默认为 30s。 也可以设置为 -1 以指示请求不应超时。

示例

edit

此示例使用固定自动缩放决策器，为名为 my_autoscaling_policy 的自动缩放策略进行设置，应用于具有（仅）"data_hot" 角色的节点集。

PUT /_autoscaling/policy/my_autoscaling_policy
{
  "roles" : [ "data_hot" ],
  "deciders": {
    "fixed": {
    }
  }
}

API返回以下结果：

{
  "acknowledged": true
}

获取自动扩展容量 API

edit

此功能旨在供 Elasticsearch Service、Elastic Cloud Enterprise 和 Elastic Cloud on Kubernetes 间接使用。不支持直接使用。

获取自动扩展容量。

请求

edit
GET /_autoscaling/capacity/

先决条件

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

描述

edit

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

计算required_capacity时，取所有为该策略启用的独立决策器required_capacity结果的最大值。

操作员应验证 current_nodes 是否与操作员对集群的了解相符，以避免基于过时或不完整的信息做出自动扩展决策。

响应包含决策器特定的信息，您可以使用这些信息来诊断自动扩展如何以及为何确定需要某个容量。这些信息仅用于诊断目的。请勿使用此信息来做出自动扩展决策。

查询参数

edit
master_timeout
(可选，时间单位) 等待主节点的时间段。如果在超时到期之前主节点不可用，请求将失败并返回错误。默认为30s。 也可以设置为-1，表示请求不应超时。

响应体

edit
policies

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

Properties of policies

(对象) 包含策略的容量信息

Properties of
required_capacity

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

Properties of required_capacity
node

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

Properties of node
storage
(整数) 每个节点所需的存储字节数。
memory
(整数) 每个节点所需的内存字节数。
processors
(浮点数) 每个节点所需的处理器（vCPU）数量。
total

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

Properties of total
storage
(整数) 策略所需的存储总字节数。
memory
(整数) 策略所需的内存总字节数。
processors
(浮点数) 策略所需的处理器（vCPU）总数量。
current_capacity

(对象) 包含策略当前管理的节点的容量，即 Elasticsearch 用于计算的节点。

Properties of current_capacity
node

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

Properties of node
storage
(整数) 节点的最大存储字节数。
memory
(整数) 节点的最大内存字节数。
processors
(浮点数) 节点的最大处理器（vCPU）数量。
total

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

Properties of total
storage
(整数) 策略可用的当前存储字节数。
memory
(整数) 策略可用的当前内存字节数。
processors
策略可用的当前处理器（vCPU）数量。
current_nodes

(对象数组) 用于容量计算的节点列表。

Properties of elements in current_nodes
name
(字符串) 节点的名称。
deciders

(对象) 容量结果来自各个决策器，允许了解外部级别required_capacity是如何计算的。

Properties of deciders

(对象) 特定决策者启用策略的容量结果。

Properties of
required_capacity

(对象) 由决策器确定的所需容量。

Properties of required_capacity
node

(对象) 包含每个节点所需的最小节点大小，确保单个分片或机器学习作业可以适应单个节点。

Properties of node
storage
(整数) 每个节点所需的存储字节数。
memory
(整数) 每个节点所需的内存字节数。
processors
(浮点数) 每个节点所需的处理器（vCPU）数量。
total

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

Properties of total
storage
(整数) 策略所需的存储总字节数。
memory
(整数) 策略所需的内存总字节数。
processors
(浮点数) 策略所需的处理器（vCPU）总数量。
reason_summary
(字符串) 决策器结果的基础描述。
reason_details
(对象) 每个决策器的结构，包含关于决策器结果基础的详细信息。 内容不应依赖于应用程序目的，并且不受向后兼容性保证的约束。

示例

edit

此示例检索当前的自动扩展容量。

GET /_autoscaling/capacity

API返回以下结果：

{
  policies: {}
}

删除自动缩放策略 API

edit

此功能旨在供 Elasticsearch Service、Elastic Cloud Enterprise 和 Elastic Cloud on Kubernetes 间接使用。不支持直接使用。

删除 自动缩放 策略。

请求

edit
DELETE /_autoscaling/policy/<name>

先决条件

edit
  • 如果启用了Elasticsearch安全功能，您必须拥有manage_autoscaling 集群权限才能使用此API。
  • 如果启用了操作员权限功能，则只有操作员用户可以使用此API。

描述

edit

此API删除具有所提供名称的自动缩放策略。

查询参数

edit
master_timeout
(可选，时间单位) 等待主节点的时间段。如果在超时到期之前主节点不可用，请求将失败并返回错误。默认为30s。 也可以设置为-1，表示请求不应超时。
timeout
(可选，时间单位) 在更新集群元数据后，等待集群中所有相关节点响应的时间段。 如果在超时到期之前未收到响应，集群元数据更新仍然适用，但响应将表明它未被完全确认。 默认为 30s。 也可以设置为 -1 以指示请求不应超时。

示例

edit

此示例删除名为 my_autoscaling_policy 的自动缩放策略。

DELETE /_autoscaling/policy/my_autoscaling_policy

API返回以下结果：

{
  "acknowledged": true
}

此示例删除所有自动缩放策略。

DELETE /_autoscaling/policy/*

API返回以下结果：

{
  "acknowledged": true
}

获取自动扩展策略 API

edit

此功能旨在供 Elasticsearch Service、Elastic Cloud Enterprise 和 Elastic Cloud on Kubernetes 间接使用。不支持直接使用。

获取自动扩展策略。

请求

edit
GET /_autoscaling/policy/<name>

前提条件

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

描述

edit

此API获取具有所提供名称的自动缩放策略。

查询参数

edit
master_timeout
(可选，时间单位) 等待主节点的时间段。如果在超时到期之前主节点不可用，请求将失败并返回错误。默认为30s。 也可以设置为-1，表示请求不应超时。

示例

edit

此示例获取名为 my_autoscaling_policy 的自动缩放策略。

GET /_autoscaling/policy/my_autoscaling_policy

API返回以下结果：

{
   "roles": <roles>,
   "deciders": <deciders>
}
« REST API compatibility Behavioral Analytics APIs »