ノード機能の使用（Nodes feature usage）

ノード機能使用API

機能の使用に関する情報を返します。

リクエスト

GET /_nodes/usage

GET /_nodes/<node_id>/usage

GET /_nodes/usage/<metric>

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

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitorまたはmanage クラスター権限が必要です。

説明

クラスターのノード使用APIを使用すると、各ノードの機能の使用に関する情報を取得できます。すべてのノード選択オプションについてはこちらで説明されています。

パスパラメータ

• <metric>
• （オプション、文字列）返される情報を特定のメトリックに制限します。以下のオプションのカンマ区切りリスト：
  • _all
  • すべての統計を返します。
  • rest_actions
  • ノードでそのアクションが呼び出された回数をカウントしたRESTアクションのクラス名を返します。
• <node_id>
• （オプション、文字列）返される情報を制限するために使用されるノードIDまたは名前のカンマ区切りリスト。

クエリパラメータ

• timeout
• （オプション、時間単位）各ノードが応答するまでの待機期間。ノードがタイムアウトが切れる前に応答しない場合、その情報は応答に含まれません。ただし、タイムアウトしたノードは応答の_nodes.failedプロパティに含まれます。デフォルトではタイムアウトなし。

例

RESTアクションの例：

Python

resp = client.nodes.usage()
print(resp)

Ruby

response = client.nodes.usage
puts response

Js

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": {
   ...
   }
   }
  }
}