データフィードを取得（Get datafeeds）

データフィードAPIの取得

データフィードの構成情報を取得します。

リクエスト

GET _ml/datafeeds/<feed_id>

GET _ml/datafeeds/<feed_id>,<feed_id>

GET _ml/datafeeds/

GET _ml/datafeeds/_all

前提条件

monitor_ml クラスター権限が必要です。この権限は machine_learning_user ビルトインロールに含まれています。

説明

このAPIは最大10,000のデータフィードを返します。

パスパラメータ

• <feed_id>
• （オプション、文字列）データフィードの識別子。データフィードの識別子またはワイルドカード式を指定できます。
  カンマ区切りのデータフィードのリストまたはワイルドカード式を使用することで、単一のAPIリクエストで複数のデータフィードの情報を取得できます。 _all を使用することで、すべてのデータフィードの情報を取得できます。データフィードの識別子として * を指定するか、識別子を省略することもできます。

クエリパラメータ

• allow_no_match
• （オプション、ブール値）リクエスト時の動作を指定します：
  • ワイルドカード式を含み、一致するデータフィードがない場合。
  • _all 文字列を含むか、識別子がない場合で、一致するものがない場合。
  • ワイルドカード式を含み、一部一致する場合。
    デフォルト値は true で、一致がない場合は空の datafeeds 配列を返し、一部一致する場合は結果のサブセットを返します。このパラメータが false の場合、一致がないか一部一致する場合はリクエストが 404 ステータスコードを返します。
• exclude_generated
• （オプション、ブール値）特定のフィールドを取得時に構成から削除するかどうかを示します。これにより、構成が取得可能な形式になり、別のクラスターに追加できるようになります。デフォルトはfalseです。

レスポンスボディ

APIはデータフィードリソースの配列を返します。プロパティの完全なリストについては、データフィードの作成APIを参照してください。

レスポンスコード

• 404 （リソースが見つかりません）
• allow_no_match が false の場合、このコードはリクエストに一致するリソースがないか、リクエストに対して一部一致のみがあることを示します。

例

Python

resp = client.ml.get_datafeeds(
   datafeed_id="datafeed-high_sum_total_sales",
)
print(resp)

Ruby

response = client.ml.get_datafeeds(
  datafeed_id: 'datafeed-high_sum_total_sales'
)
puts response

Js

const response = await client.ml.getDatafeeds({
  datafeed_id: "datafeed-high_sum_total_sales",
});
console.log(response);

コンソール

GET _ml/datafeeds/datafeed-high_sum_total_sales

APIは次の結果を返します：

コンソール-結果

{
  "count" : 1,
  "datafeeds" : [
   {
   "datafeed_id" : "datafeed-high_sum_total_sales",
   "job_id" : "high_sum_total_sales",
   "authorization" : {
   "roles" : [
   "superuser"
   ]
   },
   "query_delay" : "93169ms",
   "chunking_config" : {
   "mode" : "auto"
   },
   "indices_options" : {
   "expand_wildcards" : [
   "open"
   ],
   "ignore_unavailable" : false,
   "allow_no_indices" : true,
   "ignore_throttled" : true
   },
   "query" : {
   "bool" : {
   "filter" : [
   {
   "term" : {
   "event.dataset" : "sample_ecommerce"
   }
   }
   ]
   }
   },
   "indices" : [
   "kibana_sample_data_ecommerce"
   ],
   "scroll_size" : 1000,
   "delayed_data_check_config" : {
   "enabled" : true
   }
   }
  ]
}