ポリシーを取得（Get policy）

ライフサイクルポリシーAPIの取得

ライフサイクルポリシーを取得します。

リクエスト

GET _ilm/policy

GET _ilm/policy/<policy_id>

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmanage_ilmまたはread_ilm、またはその両方のクラスター権限が必要です。詳細については、セキュリティ権限を参照してください。

説明

指定されたポリシー定義を返します。ポリシーのバージョンと最終更新日が含まれます。ポリシーが指定されていない場合、定義されたすべてのポリシーが返されます。

パスパラメータ

• <policy_id>
• （オプション、文字列）ポリシーの識別子。

クエリパラメータ

• master_timeout
• （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
• timeout
• （オプション、時間単位）クラスターのメタデータを更新した後、クラスター内のすべての関連ノードからの応答を待機する期間。タイムアウトが切れる前に応答が受信されない場合、クラスターのメタデータの更新は適用されますが、応答は完全に承認されなかったことを示します。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。

例

次の例はmy_policyを取得します:

Python

resp = client.ilm.get_lifecycle(
   name="my_policy",
)
print(resp)

Ruby

response = client.ilm.get_lifecycle(
  policy: 'my_policy'
)
puts response

Js

const response = await client.ilm.getLifecycle({
  name: "my_policy",
});
console.log(response);

コンソール

GET _ilm/policy/my_policy

リクエストが成功した場合、応答の本文にはポリシー定義が含まれます:

コンソール-結果

{
  "my_policy": {
   "version": 1,
   "modified_date": 82392349,
   "policy": {
   "phases": {
   "warm": {
   "min_age": "10d",
   "actions": {
   "forcemerge": {
   "max_num_segments": 1
   }
   }
   },
   "delete": {
   "min_age": "30d",
   "actions": {
   "delete": {
   "delete_searchable_snapshot": true
   }
   }
   }
   }
   },
   "in_use_by" : {
   "indices" : [],
   "data_streams" : [],
   "composable_templates" : []
   }
  }
}