Skip to main content

API告警

当API发生调用失败、用户高频调用时可触发告警，将告警发送给API相关方。

告警管理​

API告警管理包括告警的创建、编辑、删除以及开启/关闭。点击「API管理-API告警-告警配置」页面，进入API告警管理模块。点击右上角的「创建告警规则」，可新建API告警规则。已创建的API规则可在列表中，可分别点击「编辑、删除」按钮进行编辑或删除。

image-20230331165958796

image-20230331165913655

基本信息​

新建/编辑某个告警规则时，基本信息包括如下内容：

  • 告警规则名称：3-100个字符，不能包含空格。
  • API告警范围：可在下拉列表中选择，点击后进入下放的API列表，并查看API名称、中文名称、创建人等，已加入列表的API可删除。选择API时，已保存的API均可选择。选择“所有API”即选中当前项目下所有已发布至api市场的api，下方不展示具体api列表，每当有一个api发布至api市场即进此告警规则的圈选监控范围，每当有一个api删除、禁用即从此告警规则中移除。

触发方式​

API的告警触发分为2种：

  • 调用失败告警：在API告警范围内调用失败，每次失败均会发送一条告警，适用于偶尔调用失败的场景。
  • 单用户每秒调用次数超出上限:创建API时,基础信息界面会设置每秒最大调用次数,超过每秒最大的调用次数,就会触发告警 image-20230914152710946

告警接收​

  • 告警次数：每天每个API发送的最大告警次数，默认值为1。 例如某API设置告警次数为3，告警间隔30分钟。1:00检测到触发了告警条件，发送一条告警；1:30时再次检测仍触发告警条件，再次发送告警。依次类推，直至达到最大告警次数。

  • 告警间隔：免打扰期间触发的告警，在结束免打扰后会发送消息通知。

  • 免打扰时间：设置免打扰时间后,免打扰时间段内不会发送消息通知,当免打扰时间结束后,会开始接受道告警消息 image-20230914161248609

  • 告警方式： 自定义告警通道,可通过公共管理,告警通道配置对应的告警配置,默认的告警方式为:短信,邮件,钉钉,微信 image-20230914162354888

  • 接收人:

    API调用人:调用人在本人API调用失败时接收对应告警 API创建人:所选择的API创建人 API管理员:角色权限为API管理员的用户都会受到告警 其他:支持用户自定义告警用户,但该用户必须在该项目内

image-20230914162901640

告警记录​

API的告警记录搜索可以从四种维度进行筛选：时间、API名称、API中文名称、API创建人

image-20230914165610242