インデックスのライフサイクルの管理には、シャードサイズやパフォーマンス要件などの要因に基づいた管理アクションの実行が含まれます。インデックスライフサイクル管理(ILM)APIを使用すると、時間の経過とともにインデックスを管理する方法を自動化できます。
この章では、ILMAPIとその使用法のリストを示します。
ポリシー管理API
API名 |
目的 |
例 |
ライフサイクルポリシーを作成します。 |
ライフサイクルポリシーを作成します。指定されたポリシーが存在する場合、ポリシーは置き換えられ、ポリシーバージョンがインクリメントされます。 |
PUT_ilm / policy / policy_id |
ライフサイクルポリシーを取得します。 |
指定されたポリシー定義を返します。ポリシーのバージョンと最終更新日が含まれます。ポリシーが指定されていない場合は、定義されているすべてのポリシーを返します。 |
GET_ilm / policy / policy_id |
ライフサイクルポリシーを削除する |
指定されたライフサイクルポリシー定義を削除します。現在使用中のポリシーは削除できません。ポリシーがインデックスの管理に使用されている場合、要求は失敗し、エラーを返します。 |
DELETE_ilm / policy / policy_id |
インデックス管理API
API名 |
目的 |
例 |
ライフサイクルステップAPIに移動します。 |
インデックスを指定されたステップに手動で移動し、そのステップを実行します。 |
POST_ilm / move / index |
ポリシーを再試行します。 |
ポリシーをエラーが発生したステップに戻し、ステップを実行します。 |
POSTインデックス/ _ilm /再試行 |
インデックスAPI編集からポリシーを削除します。 |
割り当てられたライフサイクルポリシーを削除し、指定されたインデックスの管理を停止します。インデックスパターンが指定されている場合、一致するすべてのインデックスから割り当てられたポリシーを削除します。 |
POSTインデックス/ _ilm / remove |
運用管理API
API名 |
目的 |
例 |
インデックスライフサイクル管理ステータスAPIを取得します。 |
ILMプラグインのステータスを返します。応答のoperation_modeフィールドには、STARTED、STOPPING、またはSTOPPEDの3つの状態のいずれかが表示されます。 |
GET / _ilm / status |
インデックスライフサイクル管理APIを開始します。 |
ILMプラグインが現在停止している場合は、それを開始します。クラスターが形成されると、ILMが自動的に開始されます。 |
POST / _ilm / start |
インデックスライフサイクル管理APIを停止します。 |
すべてのライフサイクル管理操作を停止し、ILMプラグインを停止します。これは、クラスターでメンテナンスを実行していて、ILMがインデックスに対してアクションを実行しないようにする必要がある場合に役立ちます。 |
POST / _ilm / stop |
ライフサイクルAPIについて説明します。 |
現在実行中のフェーズ、アクション、ステップなど、インデックスの現在のライフサイクル状態に関する情報を取得します。インデックスがそれぞれに入力された日時、実行フェーズの定義、および障害に関する情報を表示します。 |
GET index / _ilm / Explain |