菜单
Grafana云

遗留警报API

注意:从v9.0开始,遗留提醒HTTP API是弃用。它将在未来的版本中被删除。

这个话题是相关的传统仪表板警报只有。

如果您使用的是Grafana报警,请参考报警配置API

你可以找到Grafana警报API规范的细节在这里。同时,请参考Grafana报警提醒文档有关如何创建和管理新警报。

你可以使用警报API遗留仪表板警报信息及其状态,但不能使用这个API修改警报。创建新的警报或修改你需要更新仪表板JSON包含警报。

得到警报

/ api /警告/

示例请求:

HTTP / 1.1 / api /警报接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

查询字符串参数:

这些参数被用作查询字符串参数。例如:

/ api /警报? dashboardId = 1

  • dashboardId——极限响应警报在指定的仪表板(s)。您可以指定多个仪表盘,例如dashboardId = 23 &dashboardid = 35。
  • panelId——极限响应警报仪表板委员会指定。
  • 查询——极限响应警报名称这样的值。
  • 状态——返回警报与一个或多个下列警告:所有,no_data,停顿了一下,报警,好吧,等待。指定多个国家使用以下格式:? = paused&state =报警状态
  • 限制——限制反应X警报的数量。
  • folderId——极限响应警报指示板在指定的文件夹中。您可以指定多个文件夹,例如folderId = 23 &folderid = 35。
  • dashboardQuery——极限响应警报指示板名称这样的值。
  • dashboardTag——极限响应警报的仪表板指定标签。做一个”和“过滤与多个标签,多次指定标签参数如dashboardTag = tag1&dashboardTag =标签2。

示例响应:

HTTP / 1.1 200 - type: application / json ({" id ": 1、“dashboardId”: 1、“dashboardUId”:“ABcdEFghij”“dashboardSlug”:“传感器”、“panelId”: 1、“名称”:“壁炉传感器”,“状态”:“报警”、“newStateDate”:“2018 - 05 - 14 - t05:55:20 + 02:00”、“evalDate”:“0001 - 01 - 01 t00:00:00z”、“evalData”:空,“executionError”: ", " url ": " //www.tubolov.com/dashboard/db/sensors "})

通过id获取警报

GET / api /警告/:id

示例请求:

得到1 / api /警告/ HTTP / 1.1接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

示例响应:

application / json HTTP / 1.1 200 - type: {" id ": 1、“dashboardId”: 1、“dashboardUId”:“ABcdEFghij”“dashboardSlug”:“传感器”、“panelId”: 1、“名称”:“壁炉传感器”,“状态”:“报警”、“消息”:“有人试图打破通过火的地方”,“newStateDate”:“2018 - 05 - 14 - t05:55:20 + 02:00”、“evalDate”:“0001 - 01 - 01 t00:00:00z”、“evalData”:“evalMatches”:[{“指标”:“运动”、“标签”:{“名称”:“fireplace_chimney”},“价值”:98.765}],“executionError”: ", " url ": " //www.tubolov.com/dashboard/db/sensors "}

重要提示:“evalMatches”数据缓存在db当且仅当警报状态的变化(如从“ok”过渡到“提醒”状态)。

如果首先触发警报,数据从一个服务器,该服务器之前见过离开报警状态,第二个服务器也进入状态,触发警报,第二个服务器将不会显示在“evalMatches”数据。

暂停警报通过id

POST / api /警告/:id /暂停

示例请求:

POST / api /警告/ 1 /暂停HTTP / 1.1接受:application / json - type: application / json授权:无记名eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk{“暂停”:真}

:id查询参数是警惕的id被暂停或停顿。

JSON身体模式:

  • 停顿了一下- - -可以真正的。真正的暂停一个警告。假unpause警报。

示例响应:

HTTP / 1.1 200 - type: application / json {“alertId”: 1、“状态”:“暂停”、“消息”:“警惕暂停”}

暂停所有警报

看到管理API