API设置

1. 概述

1.1 功能概述

数据监控中可以使用 API 通知的方式发送告警信息，但需要提前配置 API。

本文为您介绍如何添加 API 配置。

2. 设置API

1. 系统管理员登录后，依次单击「系统管理>系统设置>通知中心>API设置」，进入API设置界面，在该界面，将 API设置置为是，启用 API设置。然后单击 添加API 按钮。

   
   

2. 配置API项目，添加API。

   type=info

   提示： 支持 Json 的 API，也就是说 content-type 请求头必须是 application/json， 这个请求头已经默认添加。

• 设置项说明：

  设置项名称	说明	系统图示（示例配置）
  API名称	自定义一个名称，不能重复。
  请求方式	支持POST和PUT两种方式。
  API授权	根据需要选择需要的API授权，支持Basic、Password和Client_credients。
  统一资源定位符	添加目标API。
  请求头	可添加除 content-type 之外的请求头，因为系统已默认添加了 content-type 请求头。
  请求体	在请求体中添加告警内容，内容必须是标准的 JSON 内容，而且数据监控的内容需要添加到“值”中。 示例添加的是推送数据集的请求体，并将内容改为监控内容。 在右上角单击系统变量，选择数据监控内容，即可将监控内容的变量添加到请求体中。 最后应用到监控中时，会将变量替换为真实的告警内容。
  测试	单击测试按钮可测试是否可以发送成功。

3. 全部编辑完成后单击最下方的 添加API 按钮，保存设置。

   
   

4. API设置添加完成后，可以禁用，编辑或删除。

   禁用后在数据监控中将不可见，之前使用该API添加的数据监控也将报错，不能发送通知。

   
   

3. 在数据监控中使用

1. 当系统管理的通知中心已完成API设置后，在添加数据监控时勾选一个或多个API 即可。

   1）勾选多个API时，将同时向多个API发送通知。但当其中一个API 不通时，将停止发送，也就是说所有API都将收不到消息。

   
   

   2）当仪表板产生告警时，查看推送数据集。可见收到了告警信息，使用 API 发送通知成功。