节点功能使用 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 或名称的逗号分隔列表。

查询参数编辑

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

示例编辑

Rest 操作示例

response = client.nodes.usage
puts 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 次。