› › ›

查询监控 API

编辑

查询监控 API

编辑

检索所有已注册的监控。

请求

编辑

GET /_watcher/_query/watches

先决条件

编辑

您必须具有 manage_watcher 或 monitor_watcher 集群权限才能使用此 API。有关详细信息，请参阅安全权限。

以分页方式检索所有监控，并可选择通过查询筛选监控。

此 API 支持以下字段

名称	必需	默认值	描述
`from`	否	0	从第一个结果开始获取的偏移量。必须是非负数。
`size`	否	10	要返回的命中数。必须是非负数。
`query`	否	null	可选，查询筛选要返回的监控。
`sort`	否	null	可选排序定义。
`search_after`	否	null	可选 search After 使用上次命中的排序值进行分页。

请注意，只有 _id 和 metadata.* 字段可以查询或排序。

此 API 返回以下顶级字段

count: 找到的监控总数。
watches: 根据 from、size 或 search_after 请求体参数的监控列表。

示例

编辑

以下示例列出所有存储的监控

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

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

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
        }
    ]
}

« 获取监控器统计 API 创建或更新监控 API »