查找监视器 API
编辑查找监视器 API
编辑根据查询参数获取监视器列表。
请求
编辑GET <kibana 主机>:<端口>/api/synthetics/monitors
GET <kibana 主机>:<端口>/s/<空间 ID>/api/synthetics/monitors
先决条件
编辑您必须在 可观测性 部分的 Synthetics 功能中拥有 read 权限，请参阅 Kibana 功能权限。
路径参数
编辑-
space_id - (可选，字符串) 空间的标识符。如果 URL 中未提供
space_id，则使用默认空间。
查询参数
编辑-
page - (可选，整数)：分页结果的页码。
-
perPage - (可选，整数)：每页的项目数。
-
sortField - (可选，字符串)：用于对结果排序的字段。可能的值：
name、createdAt、updatedAt、status。 -
sortOrder - (可选，字符串)：排序顺序（asc 或 desc）。
-
query - (可选，字符串)：自由文本查询字符串。
-
filter - (可选，字符串)：其他过滤条件。
-
tags - (可选，字符串或数组)：用于过滤监视器的标签。
-
monitorTypes - (可选，字符串或数组)：要过滤的监视器类型，（例如，
http、tcp、icmp或browser） -
locations - (可选，字符串或数组)：要按其过滤的位置。
-
projects - (可选，字符串或数组)：要按其过滤的项目。
-
schedules - (可选，字符串或数组)：要按其过滤的计划。
-
status - (可选，字符串或数组)：要按其过滤的状态。
示例
编辑以下是如何使用此 API 的示例
GET /api/synthetics/monitors?tags=prod&monitorTypes=http&locations=us-east-1&projects=project1&status=up
{
"page": 1,
"total": 24,
"monitors": [
{
"type": "icmp",
"enabled": false,
"alert": {
"status": {
"enabled": true
},
"tls": {
"enabled": true
}
},
"schedule": {
"number": "3",
"unit": "m"
},
"config_id": "e59142e5-1fe3-4aae-b0b0-19d6345e65a1",
"timeout": "16",
"name": "8.8.8.8:80",
"locations": [
{
"id": "us_central",
"label": "North America - US Central",
"geo": {
"lat": 41.25,
"lon": -95.86
},
"isServiceManaged": true
}
],
"namespace": "default",
"origin": "ui",
"id": "e59142e5-1fe3-4aae-b0b0-19d6345e65a1",
"max_attempts": 2,
"wait": "7",
"revision": 3,
"mode": "all",
"ipv4": true,
"ipv6": true,
"created_at": "2023-11-07T09:57:04.152Z",
"updated_at": "2023-12-04T19:19:34.039Z",
"host": "8.8.8.8:80"
}
],
"absoluteTotal": 24,
"perPage": 10,
}