インデックス削除API

1つ以上のインデックスを削除します。

Python

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

Ruby

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

Js

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

コンソール

  1. DELETE /my-index-000001

リクエスト

DELETE /<index>

前提条件

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

説明

インデックスを削除すると、そのドキュメント、シャード、およびメタデータが削除されます。関連するKibanaコンポーネント（データビュー、ビジュアライゼーション、ダッシュボードなど）は削除されません。

データストリームの現在の書き込みインデックスを削除することはできません。インデックスを削除するには、ロールオーバーを行い、新しい書き込みインデックスを作成する必要があります。その後、削除インデックスAPIを使用して以前の書き込みインデックスを削除できます。

パスパラメータ

  • <index>
  • （必須、文字列）削除するインデックスのカンマ区切りリスト。 インデックスエイリアスを指定することはできません。
    デフォルトでは、このパラメータはワイルドカード（*）や_allをサポートしていません。ワイルドカードや_allを使用するには、action.destructive_requires_nameクラスタ設定をfalseに設定します。

クエリパラメータ

  • allow_no_indices
  • （オプション、ブール値）falseの場合、リクエストは、ワイルドカード式、インデックスエイリアスまたは_allの値が欠落または閉じたインデックスのみを対象とする場合にエラーを返します。この動作は、リクエストが他のオープンインデックスを対象としている場合でも適用されます。たとえば、foo*,bar*を対象とするリクエストは、fooで始まるインデックスがあるが、barで始まるインデックスがない場合にエラーを返します。
    デフォルトはtrueです。
  • expand_wildcards
  • （オプション、文字列）ワイルドカードパターンが一致できるインデックスのタイプ。リクエストがデータストリームを対象とできる場合、この引数はワイルドカード式が隠れたデータストリームに一致するかどうかを決定します。カンマ区切りの値（open,hiddenなど）をサポートします。有効な値は次のとおりです：
    • all
    • すべてのデータストリームまたはインデックスに一致します（隠れたものを含む）。
    • open
    • オープンで非隠れたインデックスに一致します。また、非隠れたデータストリームにも一致します。
    • closed
    • クローズされた非隠れたインデックスに一致します。また、非隠れたデータストリームにも一致します。データストリームはクローズできません。
    • hidden
    • 隠れたデータストリームおよび隠れたインデックスに一致します。open、closed、またはその両方と組み合わせる必要があります。
    • none
    • ワイルドカードパターンは受け入れられません。
      デフォルトはopen,closedです。
  • ignore_unavailable
  • （オプション、ブール値）falseの場合、リクエストは欠落または閉じたインデックスを対象とする場合にエラーを返します。デフォルトはfalseです。
  • master_timeout
  • （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーを返します。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
  • timeout
  • （オプション、時間単位）クラスタメタデータを更新した後、クラスタ内のすべての関連ノードからの応答を待機する期間。タイムアウトが切れる前に応答が受信されない場合、クラスタメタデータの更新は適用されますが、応答は完全に承認されなかったことを示します。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。