インデックスAPIの取得

1つ以上のインデックスに関する情報を返します。データストリームの場合、APIはストリームのバックインデックスに関する情報を返します。

Python

  1. resp = client.indices.get(
  2. index="my-index-000001",
  3. )
  4. print(resp)

Ruby

  1. response = client.indices.get(
  2. index: 'my-index-000001'
  3. )
  4. puts response

Js

  1. const response = await client.indices.get({
  2. index: "my-index-000001",
  3. });
  4. console.log(response);

コンソール

  1. GET /my-index-000001

リクエスト

GET /<target>

前提条件

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

パスパラメータ

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

クエリパラメータ

  • allow_no_indices
  • (オプション、ブール値)falseの場合、リクエストは、ワイルドカード式、インデックスエイリアス、または_allの値が欠落または閉じたインデックスのみを対象とする場合にエラーを返します。この動作は、リクエストが他のオープンインデックスを対象としている場合でも適用されます。たとえば、foo*,bar*を対象とするリクエストは、インデックスがfooで始まるがbarで始まるインデックスがない場合にエラーを返します。
    デフォルトはtrueです。
  • expand_wildcards
  • (オプション、文字列)ワイルドカードパターンが一致できるインデックスのタイプ。リクエストがデータストリームを対象とできる場合、この引数はワイルドカード式が隠れたデータストリームに一致するかどうかを決定します。カンマ区切りの値をサポートします。たとえば、open,hidden。有効な値は:
    • all
    • すべてのデータストリームまたはインデックスに一致します。 隠れたものも含まれます。
    • open
    • オープンで非隠れたインデックスに一致します。また、非隠れたデータストリームにも一致します。
    • closed
    • 閉じた非隠れたインデックスに一致します。また、非隠れたデータストリームにも一致します。データストリームは閉じることができません。
    • hidden
    • 隠れたデータストリームと隠れたインデックスに一致します。openclosed、またはその両方と組み合わせる必要があります。
    • none
    • ワイルドカードパターンは受け付けられません。
      デフォルトはopenです。
  • features
  • (オプション、文字列)特定のインデックス機能に関する情報を返します。カンマ区切りの値をサポートします。有効な値はaliasesmappings、およびsettingsです。デフォルトはaliases,mappings,settingsです。
  • flat_settings
  • (オプション、ブール値)trueの場合、フラット形式で設定を返します。デフォルトはfalseです。
  • include_defaults
  • (オプション、ブール値)trueの場合、レスポンスにすべてのデフォルト設定を返します。デフォルトはfalseです。
  • ignore_unavailable
  • (オプション、ブール値)falseの場合、欠落しているインデックスを対象とするリクエストはエラーを返します。デフォルトはfalseです。
  • local
  • (オプション、ブール値)trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、マスターノードから情報を取得します。
  • master_timeout
  • (オプション、時間単位)マスターノードを待機する期間。マスターノードがタイムアウトが切れる前に利用できない場合、リクエストは失敗し、エラーを返します。デフォルトは30sです。-1に設定することもでき、リクエストがタイムアウトしないことを示します。