Elasticsearch-Cat API

通常、さまざまなElasticsearchAPIの結果はJSON形式で表示されます。しかし、JSONは常に読みやすいわけではありません。そのため、Elasticsearchでcat API機能を利用できるため、結果の印刷形式を読みやすく、理解しやすくすることができます。cat APIで使用されるさまざまなパラメーターがあり、それらはさまざまな目的を果たします。たとえば、Vという用語は出力を冗長にします。

この章では、catAPIについて詳しく学びましょう。

詳細

詳細な出力は、catコマンドの結果を適切に表示します。以下の例では、クラスターに存在するさまざまなインデックスの詳細を取得します。

GET /_cat/indices?v

上記のコードを実行すると、次のような応答が得られます。

health status index uuid pri rep docs.count docs.deleted store.size pri.store.size
yellow open schools RkMyEn2SQ4yUgzT6EQYuAA 1 1 2 1 21.6kb 21.6kb
yellow open index_4_analysis zVmZdM1sTV61YJYrNXf1gg 1 1 0 0 283b 283b
yellow open sensor-2018-01-01 KIrrHwABRB-ilGqTu3OaVQ 1 1 1 0 4.2kb 4.2kb
yellow open colleges 3ExJbdl2R1qDLssIkwDAug 1 1 0 0 283b 283b

ヘッダー

ヘッダーとも呼ばれるhパラメーターは、コマンドで指定された列のみを表示するために使用されます。

GET /_cat/nodes?h=ip,port

上記のコードを実行すると、次のような応答が得られます。

127.0.0.1 9300

ソート

sortコマンドは、クエリ内の指定された列でテーブルを並べ替えることができるクエリ文字列を受け入れます。デフォルトの並べ替えは昇順ですが、これは：descを列に追加することで変更できます。

以下の例は、ファイルされたインデックスパターンの降順で配置されたテンプレートの結果を示しています。

GET _cat/templates?v&s=order:desc,index_patterns

上記のコードを実行すると、次のような応答が得られます。

name index_patterns order version
.triggered_watches [.triggered_watches*] 2147483647
.watch-history-9 [.watcher-history-9*] 2147483647
.watches [.watches*] 2147483647
.kibana_task_manager [.kibana_task_manager] 0 7000099

カウント

countパラメーターは、クラスター全体のドキュメントの総数のカウントを提供します。

GET /_cat/count?v

上記のコードを実行すると、次のような応答が得られます。

epoch timestamp count
1557633536 03:58:56 17809