获取警报框架健康状况 API

编辑

获取警报框架健康状况 API编辑

检索警报框架的健康状况。

有关最新 API 详细信息,请参阅 开放式 API 规范

请求编辑

GET <kibana 主机>:<端口>/api/alerting/_health

GET <kibana 主机>:<端口>/s/<空间 ID>/api/alerting/_health

先决条件编辑

您必须对 管理 > 堆栈规则 功能或至少一个 分析 > 发现分析 > 机器学习可观察性安全 功能具有 read 权限。

路径参数编辑

space_id
(可选,字符串) 空间的标识符。如果 URL 中未提供 space_id,则使用默认空间。

响应代码编辑

200
表示成功调用。

示例编辑

检索警报框架的健康状况

GET api/alerting/_health

API 返回以下内容

{
   "is_sufficiently_secure":true, 
   "has_permanent_encryption_key":true, 
   "alerting_framework_health":{ 
      "decryption_health":{
         "status":"ok",
         "timestamp":"2022-06-21T21:46:15.023Z"
      },
      "execution_health":{
         "status":"ok",
         "timestamp":"2022-06-21T21:46:15.023Z"
      },
      "read_health":{
         "status":"ok",
         "timestamp":"2022-06-21T21:46:15.023Z"
      }
   }
}

is_sufficiently_secure 在启用安全但未启用 TLS 时为 false

has_permanent_encryption_key 在加密的已保存对象插件没有永久加密密钥时为 false

alerting_framework_health 有三个子状态,用于识别警报框架的健康状况:decryption_healthexecution_healthread_healthdecryption_health 返回规则解密的时间戳和状态:okwarnerrorexecution_health 返回规则执行的时间戳和状态:okwarnerrorread_health 返回规则读取事件的时间戳和状态:okwarnerror