存在確認（Exists）

Exists API

データストリーム、インデックス、またはエイリアスが存在するかどうかを確認します。

Python

resp = client.indices.exists(
   index="my-data-stream",
)
print(resp)

Ruby

response = client.indices.exists(
  index: 'my-data-stream'
)
puts response

Js

const response = await client.indices.exists({
  index: "my-data-stream",
});
console.log(response);

Console

HEAD my-data-stream

Request

HEAD <target>

Prerequisites

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

Path parameters

• <target>
• （オプション、文字列）データストリーム、インデックス、およびエイリアスのカンマ区切りリスト。ワイルドカード（*）をサポートします。

Query parameters

• allow_no_indices
• （オプション、ブール値）falseの場合、リクエストは、ワイルドカード式、インデックスエイリアス、または_allの値が欠落または閉じたインデックスのみを対象とする場合にエラーを返します。この動作は、リクエストが他のオープンインデックスを対象とする場合でも適用されます。たとえば、foo*,bar*を対象とするリクエストは、fooで始まるインデックスが存在しない場合、エラーを返します。
  デフォルトはtrueです。
• expand_wildcards
• （オプション、文字列）ワイルドカードパターンが一致できるインデックスのタイプ。リクエストがデータストリームを対象とできる場合、この引数はワイルドカード式が隠れたデータストリームに一致するかどうかを決定します。カンマ区切りの値（open,hiddenなど）をサポートします。有効な値は：
  • all
  • すべてのデータストリームまたはインデックスに一致します。 隠れたものを含みます。
  • open
  • オープンで非隠れたインデックスに一致します。また、非隠れたデータストリームにも一致します。
  • closed
  • 閉じた非隠れたインデックスに一致します。また、非隠れたデータストリームにも一致します。データストリームは閉じることができません。
  • hidden
  • 隠れたデータストリームと隠れたインデックスに一致します。open、closed、またはその両方と組み合わせる必要があります。
  • none
  • ワイルドカードパターンは受け付けられません。
    デフォルトはopenです。
• flat_settings
• （オプション、ブール値）trueの場合、設定をフラット形式で返します。デフォルトはfalseです。
• include_defaults
• （オプション、ブール値）trueの場合、レスポンスにすべてのデフォルト設定を返します。デフォルトはfalseです。
• ignore_unavailable
• （オプション、ブール値）falseの場合、リクエストは欠落または閉じたインデックスを対象とする場合にエラーを返します。デフォルトはfalseです。
• local
• （オプション、ブール値）trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、これは情報がマスターノードから取得されることを意味します。

Response codes

• 200
• すべてのターゲットが存在します。
• 404
• 指定されたターゲットの1つ以上が存在しません。