配置API认证凭据的配额控制
凭据配额可限制单位时间内凭据调用API的总次数,保护后端服务。您可以创建凭据配额策略,对绑定策略的凭据进行调用次数限制。
凭据配额策略和凭据本身是相互独立的,只有将凭据绑定凭据配额策略后,凭据配额策略才对凭据生效。
创建凭据配额策略
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > 凭据管理”。
- 单击凭据名称,进入凭据详情页面。
- 在“凭据配额策略”区域,单击“绑定”。
- 在弹窗中选择已有策略或单击“创建新策略”。
- 选择已有策略:单击“选择已有策略”后,选择策略。
- 创建新策略:请参考表1所示配置策略。
表1 配置凭据配额策略 参数
说明
策略名称
填写客户端配额策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。
支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~255个字符。
首次生效时间点
设置配额策略的生效起始时间点。例如,时长为1小时,首次生效时间点为2020/08/08 05:05:00,则表示客户端配额策略从2020/08/08 05:05:00开始生效,每个小时的05分开始到下一个小时的05分之间为一个单位时间,即05:05:00-06:05:00为一个单位时间,以此类推。
时长
配额统计的时间窗口长度。表示在该时长内允许调用API的最大次数。单位可选:秒、分、时、天。
API访问限制
在“时长”设定的时间窗口内,客户端可调用API的最大次数。取值范围:1~2,147,483,647。
描述
填写客户端配额策略的描述信息。长度为1~255个字符。
- 策略配置完成后,单击“确定”。
- 在“凭据配额策略”区域显示已创建的策略,表示凭据配额策略创建成功。
- 如果需要解绑凭据配额策略,单击“解绑”即可。
- 如果需要删除凭据配额策略,单击“绑定”,在策略所在行单击“删除”。
相关文档
如果您希望通过API创建凭据配额策略,请参考创建凭据配额。
API流量控制策略控制全局总流量,凭据配额策略控制单用户配额,二者可以叠加使用。
- 凭据配额策略:针对单个凭据(AppCode)设置调用配额,限制该凭据在单位时间内的调用次数,用于控制单个用户的资源消耗。
- API流量控制策略:针对单个API设置全局流量上限,限制所有调用方在单位时间内的总调用次数,用于保护后端服务稳定性。了解API流量控制策略请参考配置API的流量控制和配置API的流量控制2.0。