节点特性使用情况 API

编辑

返回有关特性使用情况的信息。

请求

编辑

GET /_nodes/usage

GET /_nodes/<node_id>/usage

GET /_nodes/usage/<metric>

GET /_nodes/<node_id>/usage/<metric>

前提条件

编辑
  • 如果启用了 Elasticsearch 安全特性,你必须拥有 monitormanage 集群权限 才能使用此 API。

描述

编辑

集群节点使用情况 API 允许你检索每个节点的特性使用情况信息。所有节点选择性选项都在这里进行了解释。

路径参数

编辑
<metric>

(可选,字符串) 将返回的信息限制为特定的指标。以下选项的逗号分隔列表

_all
返回所有统计信息。
rest_actions
返回 REST 操作类名,以及该操作在节点上被调用的次数计数。
<node_id>
(可选,字符串) 用于限制返回信息的节点 ID 或名称的逗号分隔列表。

查询参数

编辑
timeout
(可选,时间单位) 等待每个节点响应的周期。如果节点在其超时时间到期之前没有响应,则响应中不包含其信息。但是,超时的节点会包含在响应的 _nodes.failed 属性中。默认为无超时。

示例

编辑

Rest 操作示例

resp = client.nodes.usage()
print(resp)
response = client.nodes.usage
puts response
const response = await client.nodes.usage();
console.log(response);
GET _nodes/usage

API 返回以下响应

{
  "_nodes": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "cluster_name": "my_cluster",
  "nodes": {
    "pQHNt5rXTTWNvUgOrdynKg": {
      "timestamp": 1492553961812, 
      "since": 1492553906606, 
      "rest_actions": {
        "nodes_usage_action": 1,
        "create_index_action": 1,
        "document_get_action": 1,
        "search_action": 19, 
        "nodes_info_action": 36
      },
      "aggregations": {
        ...
      }
    }
  }
}

执行此节点使用情况请求时的时间戳。

开始记录使用情况信息时的时间戳。这等同于节点启动的时间。

此节点的搜索操作已被调用 19 次。