API管理
通过API管理,可以快速对所属服务项目的API进行限流和告警设置。本文为您介绍如何对API进行限流和告警配置。
使用限制
仅支持运维人员、项目管理员、超级管理员角色对API进行管理。
限流设置
请参见入口介绍,进入数据服务页面。
按照下图指引,进入API限流配置对话框。
在API限流配置对话框,配置参数后,单击确定。
参数
描述
限流状态
选择限流状态。
单位时间
选择限流的单位,当前仅支持选择sec。
单位时间
选择限流的单位,系统提供的单位时间包括:
sec
min
hour
day
API流量限制
填写API限流的数据。例如,企业所购买的总流量为每秒查询率是500,如果单位时间选择sec,则API流量限制填写的数据应该小于等于500。
App流量限制
填写API的下游App的流量控制。填写APP流量限制的规则:
APP流量限制对API下的所有App生效。
APP流量限制必须小于等于API流量限制。
API流量限制的优先级大于APP流量限制。例如,API流量限制为每秒查询率是1000,App1的流量限制为每秒查询率是500,App2的流量限制为每秒查询率是500,App3的流量限制为每秒查询率是500,各App流量限制的总和大于API的流量限制,但流量限制的上线为API流量限制。
APP流量限制大于API流量限制时,系统会给出报错信息。
添加App
单击添加APP,根据API限流配置页面提示选择应用、配置限流次数。
填写限流次数的规则:
特殊App的限流次数必须小于等于API流量限制。
特殊App的限流次数大于API流量限制时,系统会给出报错信息。
告警设置
请参见入口介绍,进入数据服务页面。
按照下图指引,进入API告警页面。
在API告警页面,配置API告警信息后,单击确定。
参数
描述
监控指标
选择告警规则的API监控指标。监控指标包括:
调用次数:单位时间内,调用API的总次数。
错误率:单位时间内,API调用错误总次数/API调用总次数。
平均响应时长:单位时间内,API调用总时长/API调用总次数。
单位时间
选择API调用的单位时间。单位时间包括1min 、5min、10min、30min、60min。
操作符
选择监控指标与触发阈值的比较的操作符。操作符包括=,>=,<=, <,>, !=。
触发阈值
填写告警规则的触发阈值。
通知方式
选择告警信息通知给通知人的方式。通知方式包括:
钉钉
邮箱
短信
电话
通知人
选择告警信息的接收人。
静默期
在短时间内多次告警,可以设置一个静默期,在发送告警信息后的静默期期间,系统不再重复发送相同API告警规则的信息。
状态
支持开或者关。