cat master API

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

マスターノードに関する情報を返します。これには、ID、バインドされたIPアドレス、および名前が含まれます。

Request

GET /_cat/master

Prerequisites

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

Query parameters

  • format
  • （オプション、文字列）HTTPアクセプトヘッダーの短縮版。有効な値にはJSON、YAMLなどが含まれます。
  • h
  • （オプション、文字列）表示する列名のカンマ区切りリスト。
  • help
  • （オプション、Boolean）trueの場合、レスポンスにはヘルプ情報が含まれます。デフォルトはfalseです。
  • local
  • （オプション、Boolean）trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、これはマスターノードから情報を取得することを意味します。
  • master_timeout
  • （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストが決してタイムアウトしないことを示すために-1に設定することもできます。
  • s
  • （オプション、文字列）レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • v
  • （オプション、Boolean）trueの場合、レスポンスには列見出しが含まれます。デフォルトはfalseです。

Examples

Python

  1. resp = client.cat.master(
  2.    v=True,
  3. )
  4. print(resp)

Ruby

  1. response = client.cat.master(
  2.   v: true
  3. )
  4. puts response

Js

  1. const response = await client.cat.master({
  2.   v: "true",
  3. });
  4. console.log(response);

Console

  1. GET /_cat/master?v=true

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

Txt

  1. id                     host      ip        node
  2. YzWoH_2BT-6UjVGDyPdqYg 127.0.0.1 127.0.0.1 YzWoH_2

この情報はnodesコマンドを介しても利用可能ですが、例えばすべてのノードがマスターに同意しているかを確認するだけの場合、これは少し短くなります: 

  1. % pssh -i -h list.of.cluster.hosts curl -s localhost:9200/_cat/master
  2. [1] 19:16:37 [SUCCESS] es3.vm
  3. Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
  4. [2] 19:16:37 [SUCCESS] es2.vm
  5. Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
  6. [3] 19:16:37 [SUCCESS] es1.vm
  7. Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA