クエリウォッチAPI

すべての登録されたウォッチを取得します。

リクエスト

GET /_watcher/_query/watches

前提条件

  • このAPIを使用するには、manage_watcherまたはmonitor_watcherクラスター権限が必要です。詳細については、セキュリティ権限を参照してください。

すべてのウォッチをページネーション方式で取得し、オプションでクエリによってウォッチをフィルタリングします。

このAPIは以下のフィールドをサポートします：

名前 必須 デフォルト 説明
from いいえ 0 最初の結果から取得するオフセット。非負である必要があります。
size いいえ 10 返すヒットの数。非負である必要があります。
query いいえ null オプション、クエリで返されるウォッチをフィルタリングします。
sort いいえ null オプションのソート定義。
search_after いいえ null オプションの検索後でページネーションを行います。最後のヒットのソート値を使用します。
 
  2. このAPIは以下のトップレベルフィールドを返します：
  4. -   `````count
  • 見つかったウォッチの合計数。
  • watches
  • from、sizeまたはsearch_afterリクエストボディパラメータに基づくウォッチのリスト。

例

以下の例は、すべての保存されたウォッチをリストします:

Python

  1. resp = client.watcher.query_watches()
  2. print(resp)

Js

  1. const response = await client.watcher.queryWatches();
  2. console.log(response);

コンソール

  1. GET /_watcher/_query/watches

レスポンス：

コンソール-結果

  1. {
  2.    "count": 1,
  3.    "watches": [
  4.    {
  5.    "_id": "my_watch",
  6.    "watch": {
  7.    "trigger": {
  8.    "schedule": {
  9.    "hourly": {
  10.    "minute": [
  11.    0,
  12.    5
  13.    ]
  14.    }
  15.    }
  16.    },
  17.    "input": {
  18.    "simple": {
  19.    "payload": {
  20.    "send": "yes"
  21.    }
  22.    }
  23.    },
  24.    "condition": {
  25.    "always": {}
  26.    },
  27.    "actions": {
  28.    "test_index": {
  29.    "index": {
  30.    "index": "test"
  31.    }
  32.    }
  33.    }
  34.    },
  35.    "status": {
  36.    "state": {
  37.    "active": true,
  38.    "timestamp": "2015-05-26T18:21:08.630Z"
  39.    },
  40.    "actions": {
  41.    "test_index": {
  42.    "ack": {
  43.    "timestamp": "2015-05-26T18:21:08.630Z",
  44.    "state": "awaits_successful_execution"
  45.    }
  46.    }
  47.    },
  48.    "version": -1
  49.    },
  50.    "_seq_no": 0,
  51.    "_primary_term": 1
  52.    }
  53.    ]
  54. }