スナップショットライフサイクルポリシーAPI

1つ以上のスナップショットライフサイクルポリシー定義と最新のスナップショット試行に関する情報を取得します。

リクエスト

GET _slm/policy/<policy-id>

GET _slm/policy

前提条件

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

説明

指定されたポリシー定義と、スナップショットの作成に成功した最新の試行と失敗した試行に関する情報を返します。ポリシーが指定されていない場合、定義されたすべてのポリシーを返します。

パスパラメータ

  • <policy-id>
  • (オプション、文字列)スナップショットライフサイクルポリシーIDのカンマ区切りリスト。

特定のポリシーを取得

  1. #### Python
  2. ``````python
  3. resp = client.slm.get_lifecycle(
  4. policy_id="daily-snapshots",
  5. human=True,
  6. )
  7. print(resp)
  8. `

Ruby

  1. response = client.slm.get_lifecycle(
  2. policy_id: 'daily-snapshots',
  3. human: true
  4. )
  5. puts response

Js

  1. const response = await client.slm.getLifecycle({
  2. policy_id: "daily-snapshots",
  3. human: "true",
  4. });
  5. console.log(response);

コンソール

  1. GET _slm/policy/daily-snapshots?human

このリクエストは次の応答を返します:

コンソール-結果

  1. {
  2. "daily-snapshots": {
  3. "version": 1,
  4. "modified_date": "2099-05-06T01:30:00.000Z",
  5. "modified_date_millis": 4081757400000,
  6. "policy" : {
  7. "schedule": "0 30 1 * * ?",
  8. "name": "<daily-snap-{now/d}>",
  9. "repository": "my_repository",
  10. "config": {
  11. "indices": ["data-*", "important"],
  12. "ignore_unavailable": false,
  13. "include_global_state": false
  14. },
  15. "retention": {
  16. "expire_after": "30d",
  17. "min_count": 5,
  18. "max_count": 50
  19. }
  20. },
  21. "stats": {
  22. "policy": "daily-snapshots",
  23. "snapshots_taken": 0,
  24. "snapshots_failed": 0,
  25. "snapshots_deleted": 0,
  26. "snapshot_deletion_failures": 0
  27. },
  28. "next_execution": "2099-05-07T01:30:00.000Z",
  29. "next_execution_millis": 4081843800000
  30. }
  31. }
スナップショットポリシーのバージョン、最新のバージョンのみが保存され、ポリシーが更新されると増加します
このポリシーが最後に変更された時間。
このポリシーが次に実行される時間。

すべてのポリシーを取得

Python

  1. resp = client.slm.get_lifecycle()
  2. print(resp)

Ruby

  1. response = client.slm.get_lifecycle
  2. puts response

Js

  1. const response = await client.slm.getLifecycle();
  2. console.log(response);

コンソール

  1. GET _slm/policy