查询手表 API
编辑查询手表 API编辑
检索所有已注册的手表。
请求编辑
GET /_watcher/_query/watches
先决条件编辑
- 您必须具有
manage_watcher或monitor_watcher集群权限才能使用此 API。有关更多信息，请参见 安全权限。
以分页方式检索所有手表，并可以选择通过查询过滤手表。
此 API 支持以下字段
| 名称 | 必需 | 默认值 | 描述 |
|---|---|---|---|
|
否 |
0 |
要获取的第一个结果的偏移量。必须为非负数。 |
|
否 |
10 |
要返回的命中数。必须为非负数。 |
|
否 |
null |
可选，查询 过滤要返回的手表。 |
|
否 |
null |
可选 排序定义。 |
|
否 |
null |
可选 搜索后 使用最后命中结果的排序值进行分页。 |
请注意，只有 _id 和 metadata.* 字段是可查询或可排序的。
此 api 返回以下顶级字段
-
count - 找到的手表总数。
-
watches - 基于
from、size或search_after请求体参数的手表列表。
示例编辑
以下示例列出所有存储的手表
GET /_watcher/_query/watches
响应
{
"count": 1,
"watches": [
{
"_id": "my_watch",
"watch": {
"trigger": {
"schedule": {
"hourly": {
"minute": [
0,
5
]
}
}
},
"input": {
"simple": {
"payload": {
"send": "yes"
}
}
},
"condition": {
"always": {}
},
"actions": {
"test_index": {
"index": {
"index": "test"
}
}
}
},
"status": {
"state": {
"active": true,
"timestamp": "2015-05-26T18:21:08.630Z"
},
"actions": {
"test_index": {
"ack": {
"timestamp": "2015-05-26T18:21:08.630Z",
"state": "awaits_successful_execution"
}
}
},
"version": -1
},
"_seq_no": 0,
"_primary_term": 1
}
]
}