クラスター設定API

クラスター全体の設定を返します。

Python

  1. resp = client.cluster.get_settings()
  2. print(resp)

Ruby

  1. response = client.cluster.get_settings
  2. puts response

Js

  1. const response = await client.cluster.getSettings();
  2. console.log(response);

コンソール

  1. GET /_cluster/settings

前提条件

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

リクエスト

GET /_cluster/settings

説明

デフォルトでは、このAPI呼び出しは明示的に定義された設定のみを返しますが、include_defaultsパラメータを呼び出すことでデフォルト設定も含めることができます。

クエリパラメータ

  • flat_settings
  • （オプション、ブール値）trueの場合、設定をフラット形式で返します。デフォルトはfalseです。
  • include_defaults
  • （オプション、ブール値）trueの場合、ローカルノードからデフォルトのクラスター設定を返します。デフォルトはfalseです。
  • master_timeout
  • （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。