catカウント（cat count）

cat count API

cat APIは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、count APIを使用してください。

データストリーム、インデックス、またはクラスタ全体のドキュメント数に迅速にアクセスできます。

ドキュメント数には、マージプロセスによってまだ削除されていない削除されたドキュメントは含まれず、ライブドキュメントのみが含まれます。

Request

GET /_cat/count/<target>

GET /_cat/count

Prerequisites

• Elasticsearchのセキュリティ機能が有効になっている場合、取得するデータストリーム、インデックス、またはエイリアスに対してread インデックス権限を持っている必要があります。

Path parameters

• <target>
• （オプション、文字列）リクエストを制限するために使用されるデータストリーム、インデックス、およびエイリアスのカンマ区切りリスト。ワイルドカード（*）をサポートします。すべてのデータストリームとインデックスを対象とするには、このパラメータを省略するか、*または_allを使用します。

Query parameters

• format
• （オプション、文字列）HTTP accept headerの短縮版。妥当な値にはJSON、YAMLなどが含まれます。
• h
• （オプション、文字列）表示する列名のカンマ区切りリスト。
• help
• （オプション、Boolean）trueの場合、レスポンスにはヘルプ情報が含まれます。デフォルトはfalseです。
• s
• （オプション、文字列）レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
• v
• （オプション、Boolean）trueの場合、レスポンスには列見出しが含まれます。デフォルトはfalseです。

Examples

Example with an individual data stream or index

次のcount APIリクエストは、my-index-000001データストリームまたはインデックスのドキュメント数を取得します。

Python

resp = client.cat.count(
   index="my-index-000001",
   v=True,
)
print(resp)

Ruby

response = client.cat.count(
  index: 'my-index-000001',
  v: true
)
puts response

Js

const response = await client.cat.count({
  index: "my-index-000001",
  v: "true",
});
console.log(response);

Console

GET /_cat/count/my-index-000001?v=true

APIは次のレスポンスを返します：

Txt

epoch      timestamp count
1475868259 15:24:20  120

Example with all data streams and indices in a cluster

次のcount APIリクエストは、クラスタ内のすべてのデータストリームとインデックスのドキュメント数を取得します。

Python

resp = client.cat.count(
   v=True,
)
print(resp)

Ruby

response = client.cat.count(
  v: true
)
puts response

Js

const response = await client.cat.count({
  v: "true",
});
console.log(response);

Console

GET /_cat/count?v=true

APIは次のレスポンスを返します：

Txt

epoch      timestamp count
1475868259 15:24:20  121