cat datafeeds API

cat API は、コマンドラインまたは Kibana コンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、get datafeed statistics API を使用してください。

データフィードに関する設定と使用情報を返します。

Request

GET /_cat/ml/datafeeds/<feed_id>

GET /_cat/ml/datafeeds

Prerequisites

  • Elasticsearch のセキュリティ機能が有効になっている場合、この API を使用するには monitor_ml、monitor、manage_ml、または manage クラスター権限が必要です。Security privileges および Machine learning security privileges を参照してください。

Description

データフィードは、異常検出ジョブによる分析のために Elasticsearch からデータを取得します。詳細については、Datafeeds を参照してください。

この API は最大 10,000 ジョブを返します。

Path parameters

  • <feed_id>
  • （オプション、文字列）データフィードを一意に識別する数値文字列。この識別子は、小文字の英数字（a-z および 0-9）、ハイフン、アンダースコアを含むことができます。英数字で始まり、英数字で終わる必要があります。

Query parameters

  • allow_no_match
  • （オプション、ブール値）リクエスト時の動作を指定します：
    • ワイルドカード式を含み、一致するデータフィードがない場合。
    • _all 文字列を含むか、識別子がない場合で、一致がない場合。
    • ワイルドカード式を含み、部分一致のみがある場合。
      デフォルト値は true で、一致がない場合は空の datafeeds 配列を返し、部分一致がある場合は結果のサブセットを返します。このパラメータが false の場合、リクエストは一致がない場合または部分一致のみの場合に 404 ステータスコードを返します。
  • format
  • （オプション、文字列）HTTP accept header の短縮版。 有効な値には JSON、YAML などが含まれます。
  • h
  • （オプション、文字列）表示する列名のカンマ区切りリスト。
    どの列を含めるか指定しない場合、API はデフォルトの列を返します。1つ以上の列を明示的に指定した場合、指定された列のみを返します。
    有効な列は：
    • assignment_explanation、ae
    • 開始されたデータフィードのみ、ノードの選択に関するメッセージを含みます。
    • buckets.count、bc、bucketsCount
    • （デフォルト）処理されたバケットの数。
    • id
    • （デフォルト）データフィードを一意に識別する数値文字列。この識別子は、小文字の英数字（a-z および 0-9）、ハイフン、アンダースコアを含むことができます。英数字で始まり、英数字で終わる必要があります。
    • node.address、na、nodeAddress
    • ノードのネットワークアドレス。
      開始されたデータフィードのみ、この情報はデータフィードが開始されたノードに関連します。
    • node.ephemeral_id、ne、nodeEphemeralId
    • ノードのエフェメラル ID。
      開始されたデータフィードのみ、この情報はデータフィードが開始されたノードに関連します。
    • node.id、ni、nodeId
    • ノードの一意の識別子。
      開始されたデータフィードのみ、この情報はデータフィードが開始されたノードに関連します。
    • node.name、nn、nodeName
    • ノード名。
      開始されたデータフィードのみ、この情報はデータフィードが開始されたノードに関連します。
    • search.bucket_avg、sba、searchBucketAvg
    • バケットごとの平均検索時間（ミリ秒）。
    • search.count、sc、searchCount
    • （デフォルト）データフィードによって実行された検索の数。
    • search.exp_avg_hour、seah、searchExpAvgHour
    • 時間あたりの指数移動平均検索時間（ミリ秒）。
    • search.time、st、searchTime
    • データフィードが検索に費やした合計時間（ミリ秒）。
    • state、s
    • （デフォルト）データフィードのステータスで、次の値のいずれかになります：
      • starting: データフィードの開始が要求されましたが、まだ開始されていません。
      • started: データフィードはデータを受信しています。
      • stopping: データフィードは優雅に停止するように要求されており、最終アクションを完了しています。
      • stopped: データフィードは停止しており、再起動されるまでデータを受信しません。
  • help
  • （オプション、ブール値）true の場合、レスポンスにはヘルプ情報が含まれます。デフォルトは false です。
  • s
  • （オプション、文字列）レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • time
  • （オプション、time units）時間値を表示するために使用される単位。
  • v
  • （オプション、ブール値）true の場合、レスポンスには列見出しが含まれます。デフォルトは false です。

Examples

Python

  1. resp = client.cat.ml_datafeeds(
  2.    v=True,
  3. )
  4. print(resp)

Ruby

  1. response = client.cat.ml_datafeeds(
  2.   v: true
  3. )
  4. puts response

Js

  1. const response = await client.cat.mlDatafeeds({
  2.   v: "true",
  3. });
  4. console.log(response);

Console

  1. GET _cat/ml/datafeeds?v=true

Console-Result

  1. id                              state buckets.count search.count
  2. datafeed-high_sum_total_sales stopped 743          7
  3. datafeed-low_request_rate     stopped 1457         3
  4. datafeed-response_code_rates  stopped 1460         18
  5. datafeed-url_scanning         stopped 1460         18