Elasticsearch-Cat API

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

この章では、cat APIについて詳しく説明します。

冗長

詳細出力では、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

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

Elasticsearch-cat-apis

Elasticsearch-Cat API

冗長

ヘッダ

Sort

カウント

目次