データストリームライフサイクルの取得（Get Data Stream Lifecycle）

データストリームのライフサイクルを取得する

一連のdata streamsのlifecycleを取得します。

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するには、少なくともmanageindex privilege、manage_data_stream_lifecycleインデックス特権、またはview_index_metadata特権のいずれかを持っている必要があります。詳細については、Security privilegesを参照してください。

リクエスト

GET _data_stream/<data-stream>/_lifecycle

説明

指定されたデータストリームのライフサイクルを取得します。複数のデータストリームが要求され、少なくとも1つが存在しない場合、要求されたリソースの少なくとも1つを取得できなかったため、APIは404で応答します。要求されたデータストリームにライフサイクルが設定されていない場合でも、APIの応答には含まれますが、lifecycleキーは欠落します。

パスパラメータ

• <data-stream>
• (必須、文字列) リクエストを制限するために使用されるデータストリームのカンマ区切りリスト。ワイルドカード(*)をサポートします。すべてのデータストリームを対象とするには、*または_allを使用します。

クエリパラメータ

• expand_wildcards
• (オプション、文字列) ワイルドカードパターンが一致できるデータストリームのタイプ。カンマ区切りの値をサポートします。例: open,hidden。有効な値は:
  • all, hidden
  • hiddenなデータストリームを含む任意のデータストリームと一致します。
  • open, closed
  • 非表示のデータストリームと一致します。データストリームは閉じることができません。
  • none
  • ワイルドカードパターンは受け付けられません。
    デフォルトはopenです。
• include_defaults
• (オプション、Boolean) trueの場合、応答にすべてのデフォルト設定を返します。デフォルトはfalseです。

レスポンスボディ

• data_streams
• (オブジェクトの配列) 取得したデータストリームのライフサイクルに関する情報を含みます。

  - `````name

  • (文字列) データストリームの名前。
  • lifecycle
  • (オプション、オブジェクト)

    - `````data_retention

    • (オプション、文字列) 定義されている場合、このデータストリームに追加されたすべてのドキュメントは、この期間中は少なくとも保存されます。この期間を過ぎると、ドキュメントは削除される可能性があります。未定義の場合、このデータストリーム内のすべてのドキュメントは無期限に保存されます。
    • rollover
    • (オプション、オブジェクト) クラスタ設定cluster.lifecycle.default.rolloverによって構成されたバックインデックスのロールオーバーをトリガーする条件。このプロパティは実装の詳細であり、クエリパラメータinclude_defaultsがtrueに設定されている場合にのみ取得されます。このフィールドの内容は変更される可能性があります。

例

ライフサイクルを取得しましょう:

Python

resp = client.indices.get_data_lifecycle(
   name="my-data-stream*",
)
print(resp)

Ruby

response = client.indices.get_data_lifecycle(
  name: 'my-data-stream*'
)
puts response

Js

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

コンソール

GET _data_stream/my-data-stream*/_lifecycle

応答は次のようになります:

コンソール-結果

{
  "data_streams": [
   {
   "name": "my-data-stream-1",
   "lifecycle": {
   "enabled": true,
   "data_retention": "7d"
   }
   },
   {
   "name": "my-data-stream-2",
   "lifecycle": {
   "enabled": true,
   "data_retention": "7d"
   }
   }
  ]
}