API告警

告警配置

API告警用于及时告知用户API调用失败的情况,并支持单次调用失败和某时间段内累计调用失败达到指定次数两种配置方式。

  • 权限说明:

    • 数据开发和应用开发:可创建告警规则、仅针对自己创建的告警规则有关闭开启、编辑和删除权限。

    • API管理员及以上角色:具有所有权限;

告警配置流程如下:

步骤一 创建‘告警规则按钮’

用户进入顶部的「API管理」菜单,点击左侧的「API告警-告警配置」,点击「创建告警规则」按钮。

步骤二 告警规则详细配置

告警规则_1

选择API:

  • 搜索方式:支持搜索API英文和中文名称。

  • 选择范围:项目内已发布至API市场的所有API。

  • 选择数量:至多添加100个API

触发方式:

  • 方式一:API某次调用失败后触发一次告警。

  • 方式二:某时间段内调用失败累计达到规定次数后触发一次告警。

    • 支持时间的单位:秒,分钟,小时,天,周。

    • 时间计算规则:告警生效时为计算起点,触发告警或本轮时间段结束后开始新一轮的时间计算。以此类推直至达到告警接收中的限制后不再发送告警;

    • 每个API的告警触发互相独立,互不影响。

告警接收:

  • 告警次数:每天每个API发送的最大告警次数,达到告警次数后即使仍触发警告系统也不再发送。

  • 告警间隔:新一次告警与上一次告警间的最小时间间隔。

    • 示例:告警间隔为60分钟;触发方式为50秒调用失败100次。
      配置完成后立即生效,并直至50秒内如果调用失败100次,第一次告警。告警后若仍满足“50秒内调用失败100次”的触发报警条件,系统会在60分钟后执行第二次告警。

  • 免打扰时间:免打扰时间段内系统不会发送告警。

  • 告警方式:支持邮件、短信(对接webservice的短信告警通道)、钉钉

1.告警方式各渠道中发送的时间为告警触发时间。
2.告警规则创建完成后默认打开并立即生效,点击“关闭”后不再检测该告警条件,停止发送告警;

告警记录

记录每条告警记录,包括告警触发时间、API名称、API中文名称、API创建人、告警规则、触发方式、告警方式、告警接收人。