データストリームAPI - データストリームの取得（Get data stream）

データストリームAPIの取得
リクエスト
前提条件
パスパラメータ
クエリパラメータ
レスポンスボディ
例

データストリームAPIの取得

1つ以上のdata streamsに関する情報を取得します。データストリームに関する情報を取得を参照してください。

Python

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

Ruby

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

Js

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

コンソール

GET /_data_stream/my-data-stream

リクエスト

GET /_data_stream/<data-stream>

前提条件

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

パスパラメータ

<data-stream>
（オプション、文字列）リクエストを制限するために使用されるデータストリーム名のカンマ区切りリスト。ワイルドカード(*)式がサポートされています。省略した場合、すべてのデータストリームが返されます。

クエリパラメータ

expand_wildcards
（オプション、文字列）ワイルドカードパターンが一致できるデータストリームのタイプ。カンマ区切りの値をサポートし、open,hiddenなどが含まれます。有効な値は：
- all, hidden
- すべてのデータストリームに一致し、隠しデータストリームも含まれます。
- open, closed
- すべての非隠しデータストリームに一致します。データストリームは閉じることができません。
- none
- ワイルドカードパターンは受け付けられません。
  デフォルトはopenです。
include_defaults
（オプション、ブール値）[プレビュー]の機能。この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。 . trueの場合、応答にすべてのデフォルト設定を返します。デフォルトはfalseです。

レスポンスボディ

data_streams
（オブジェクトの配列）取得したデータストリームに関する情報を含みます。
```
-   `````name
```
- （文字列）データストリームの名前。
- timestamp_field
- （オブジェクト）データストリームの@timestampフィールドに関する情報を含みます。
```
-   `````name
```
  - （文字列）データストリームのタイムスタンプフィールドの名前で、@timestampである必要があります。@timestampフィールドは、データストリームにインデックスされたすべてのドキュメントに含まれている必要があります。
- indices
- （オブジェクトの配列）データストリームのバックインデックスに関する情報を含むオブジェクトの配列。
  この配列の最後の項目は、ストリームの現在の書き込みインデックスに関する情報を含みます。
```
-   `````index_name
```
  - （文字列）バックインデックスの名前。命名規則については、生成を参照してください。
  - index_uuid
  - （文字列）インデックスのユニバーサルユニーク識別子（UUID）。
  - prefer_ilm
  - （ブール値）[プレビュー]の機能。この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。 . このインデックスが、インデックスライフサイクル管理とデータストリームライフサイクルの両方がこのインデックスを管理するように構成されている場合、インデックスライフサイクル管理を優先するように設定されているかどうかを示します。
  - managed_by
  - （文字列）[プレビュー]の機能。この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。 . このインデックスを管理しているシステムを示します。
- generation
- （整数）データストリームの現在の世代。この数値は、1から始まるストリームのロールオーバーの累積カウントとして機能します。
- _meta
- （オブジェクト）ストリームのカスタムメタデータで、ストリームの一致するインデックステンプレートの_metaオブジェクトからコピーされます。空の場合、応答はこのプロパティを省略します。
- status
- （文字列）データストリームのヘルスステータス。
  このヘルスステータスは、ストリームのバックインデックスのプライマリおよびレプリカシャードの状態に基づいています。
```
-   `````GREEN
```
  - すべてのシャードが割り当てられています。
  - YELLOW
  - すべてのプライマリシャードが割り当てられていますが、1つ以上のレプリカシャードが未割り当てです。
  - RED
  - 1つ以上のプライマリシャードが未割り当てであるため、一部のデータが利用できません。
- template
- （文字列）データストリームのバックインデックスを作成するために使用されるインデックステンプレートの名前。
  テンプレートのインデックスパターンは、このデータストリームの名前と一致する必要があります。インデックステンプレートを作成するを参照してください。
- ilm_policy
- （文字列）ストリームの一致するインデックステンプレートにおける現在のILMライフサイクルポリシーの名前。このライフサイクルポリシーはindex.lifecycle.name設定で設定されます。
  テンプレートにライフサイクルポリシーが含まれていない場合、このプロパティは応答に含まれません。
  データストリームのバックインデックスには異なるライフサイクルポリシーが割り当てられる場合があります。個々のバックインデックスのライフサイクルポリシーを取得するには、インデックス設定APIを取得するを使用します。
- next_generation_managed_by
- （文字列）[プレビュー]の機能。この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。 . 次世代インデックス（すなわち、次のデータストリーム書き込みインデックス）を管理するシステムを示します。
- prefer_ilm
- （ブール値）[プレビュー]の機能。この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。 . データストリームのバックインデックスを作成するために使用されるインデックステンプレートが、インデックスライフサイクル管理とデータストリームライフサイクルの両方がこのインデックスを管理するように構成されている場合、インデックスライフサイクル管理を優先するように設定されているかどうかを示します。
- hidden
- （ブール値）trueの場合、データストリームは隠しです。
- system
- （ブール値）trueの場合、データストリームはElasticスタックコンポーネントによって作成および管理され、通常のユーザー操作を通じて変更することはできません。
- allow_custom_routing
- （ブール値）trueの場合、このデータストリームは書き込みリクエストにカスタムルーティングを許可します。
- replicated
- （ブール値）trueの場合、データストリームはクロスクラスターレプリケーションによって作成および管理され、ローカルクラスタはこのデータストリームに書き込むことも、そのマッピングを変更することもできません。
- lifecycle
- （オブジェクト）[プレビュー]の機能。この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。 . このデータストリームのデータストリームライフサイクル管理の設定を含みます。
```
-   `````data_retention
```
  - （文字列）定義されている場合、このデータストリームに追加されたすべてのドキュメントは、少なくともこの期間保存されます。この期間を過ぎた後、ドキュメントは削除される可能性があります。空の場合、このデータストリーム内のすべてのドキュメントは無期限に保存されます。
  - rollover
  - （オブジェクト）バックインデックスのロールオーバーをトリガーする条件。これはクラスタ設定cluster.lifecycle.default.rolloverによって構成されます。このプロパティは実装の詳細であり、クエリパラメータinclude_defaultsがtrueに設定されている場合にのみ取得されます。このフィールドの内容は変更される可能性があります。
- rollover_on_write
- （ブール値）trueの場合、次の書き込みがこのデータストリームに対して最初にロールオーバーをトリガーし、ドキュメントは新しいバックインデックスにインデックスされます。ロールオーバーが失敗した場合、インデックスリクエストも失敗します。

例

Python

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

Ruby

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

Js

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

コンソール

GET _data_stream/my-data-stream*

APIは次の応答を返します：

コンソール-結果

{
  "data_streams": [
   {
   "name": "my-data-stream",
   "timestamp_field": {
   "name": "@timestamp"
   },
   "indices": [
   {
   "index_name": ".ds-my-data-stream-2099.03.07-000001",
   "index_uuid": "xCEhwsp8Tey0-FLNFYVwSg",
   "prefer_ilm": true,
   "ilm_policy": "my-lifecycle-policy",
   "managed_by": "Index Lifecycle Management"
   },
   {
   "index_name": ".ds-my-data-stream-2099.03.08-000002",
   "index_uuid": "PA_JquKGSiKcAKBA8DJ5gw",
   "prefer_ilm": true,
   "ilm_policy": "my-lifecycle-policy",
   "managed_by": "Index Lifecycle Management"
   }
   ],
   "generation": 2,
   "_meta": {
   "my-meta-field": "foo"
   },
   "status": "GREEN",
   "next_generation_managed_by": "Index Lifecycle Management",
   "prefer_ilm": true,
   "template": "my-index-template",
   "ilm_policy": "my-lifecycle-policy",
   "hidden": false,
   "system": false,
   "allow_custom_routing": false,
   "replicated": false,
   "rollover_on_write": false
   },
   {
   "name": "my-data-stream-two",
   "timestamp_field": {
   "name": "@timestamp"
   },
   "indices": [
   {
   "index_name": ".ds-my-data-stream-two-2099.03.08-000001",
   "index_uuid": "3liBu2SYS5axasRt6fUIpA",
   "prefer_ilm": true,
   "ilm_policy": "my-lifecycle-policy",
   "managed_by": "Index Lifecycle Management"
   }
   ],
   "generation": 1,
   "_meta": {
   "my-meta-field": "foo"
   },
   "status": "YELLOW",
   "next_generation_managed_by": "Index Lifecycle Management",
   "prefer_ilm": true,
   "template": "my-index-template",
   "ilm_policy": "my-lifecycle-policy",
   "hidden": false,
   "system": false,
   "allow_custom_routing": false,
   "replicated": false,
   "rollover_on_write": false
   }
  ]
}