获取规则 API
编辑获取规则 API编辑
通过 ID 检索规则。
有关最新 API 详细信息，请参阅 开放 API 规范。
请求编辑
GET <kibana 主机>:<端口>/api/alerting/rule/<id>
GET <kibana 主机>:<端口>/s/<空间 ID>/api/alerting/rule/<id>
先决条件编辑
您必须对相应的 Kibana 功能具有 read 权限，具体取决于您要查找的规则的 consumer 和 rule_type_id。例如，管理 > 堆栈规则 功能，分析 > 发现 和 机器学习 功能，可观察性 和 安全 功能。要获取与 堆栈监控 功能关联的规则，请使用 monitoring_user 内置角色。
有关更多详细信息，请参阅 功能权限。
路径参数编辑
-
id - (必需，字符串) 要检索的规则的标识符。
-
space_id - (可选，字符串) 空间的标识符。如果 URL 中未提供
space_id，则使用默认空间。
响应代码编辑
-
200 - 表示成功调用。
示例编辑
检索具有 ID 41893910-6bca-11eb-9e0d-85d233e3ee35 的规则对象
GET api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35
API 返回以下内容
{
"id":"31697a40-7b36-11ed-aa79-f742c05329b2",
"consumer":"alerts",
"tags":["cpu"],
"name":"my alert",
"enabled":true,
"throttle":null,
"schedule":{
"interval":"1m"
},
"params":{
"aggType":"avg",
"termSize":6,
"thresholdComparator":">",
"timeWindowSize":5,
"timeWindowUnit":"m",
"groupBy":"top",
"threshold":[1000],
"index":["test-index"],
"timeField":"@timestamp",
"aggField":"sheet.version",
"termField":"name.keyword"
},
"rule_type_id":".index-threshold",
"created_by":"elastic",
"updated_by":"elastic",
"created_at":"2022-12-13T22:33:41.163Z",
"updated_at":"2022-12-13T22:33:41.163Z",
"api_key_owner":"elastic",
"notify_when":"onActionGroupChange",
"muted_alert_ids":[],
"mute_all":false,
"scheduled_task_id":"31697a40-7b36-11ed-aa79-f742c05329b2",
"execution_status":{
"status":"ok",
"last_execution_date":"2022-12-13T22:33:44.388Z",
"last_duration":83
},
"actions":[{
"group":"threshold met",
"id":"1007a0c0-7a6e-11ed-89d5-abec321c0def",
"params":{
"level":"info",
"message":"Rule {{rule.name}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}\n- Timestamp: {{context.date}}"
},
"connector_type_id":".server-log"
}],
"last_run":{
"alerts_count":{
"new":0,
"ignored":0,
"recovered":0,
"active":0
},
"outcome_msg":null,
"warning":null,
"outcome":"succeeded"
},
"next_run":"2022-12-13T22:34:44.314Z"
}