文档首页/ API中心 API Hub/ 用户指南/ API网关代理/ API策略/ 流量控制策略说明
更新时间：2023-12-08 GMT+08:00
查看PDF
分享

流量控制策略说明

流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。

使用限制

同一个环境中，一个API只能被一个流控策略绑定，但一个流控策略可以绑定多个API。

配置参数说明

表1 配置参数说明

信息项

描述

策略名称

API流控策略名称。

类型

分“基础流控”和“共享流控”两类。

  • 基础流控：针对单个API进行流量统计和控制。
  • 共享流控：针对绑定了该策略的所有API进行总流量统计和控制。

时长

流量限制的时长。时长单位支持秒，分钟，小时，天。

  • 与“API流量限制”配合使用，表示“时长”时间内的单个API请求次数上限。
  • 与“用户流量限制”配合使用，表示“时长”时间内的单个用户请求次数上限。
  • 与“凭据流量限制”配合使用，表示“时长”时间内的单个凭据请求次数上限。
  • 与“源IP流量限制”配合使用，表示“时长”时间内的单个IP地址请求次数上限。

API流量限制

单个API被调用次数上限。

与“时长”配合使用，表示“时长”时间内的单个API请求次数上限。

用户流量限制

单个用户调用API次数上限，仅在API的安全认证方式为“华为IAM认证”时适用。

  • 不能大于“API流量限制”的值。
  • 与“时长”配合使用，表示“时长”时间内的单个用户请求次数上限。
  • 如果主账号下有多个子用户访问API，按主账号累计的调用次数进行限制。
说明：

如果希望单独为某个用户添加流量控制策略，可以通过对该策略增加特殊租户实现，具体参考添加特殊租户。增加特殊租户后，此用户调用API次数的上限受增加特殊租户时设置的“阈值”限制，其他用户调用API次数的上限，仍然受本参数值限制。

凭据流量限制

单个凭据调用API次数上限，仅在API的安全认证方式为“APP认证”时适用。

  • 不能大于“API流量限制”的值。
  • 与“时长”配合使用，表示“时长”时间内的凭据请求次数上限。
说明：

如果希望单独为某个凭据添加流量控制策略，可以通过对该策略增加特殊应用实现，具体参考添加特殊应用。增加特殊应用后，此凭据调用API次数的上限受增加特殊应用时设置的“阈值”限制，其他凭据调用API次数的上限，仍然受本参数值限制。

源IP流量限制

单个IP地址调用API次数上限。

  • 不能大于“API流量限制”的值。
  • 与“时长”配合使用，表示“时长”时间内的IP地址请求次数上限。

描述

关于控制策略的描述。

添加特殊应用

已创建凭据，或已获取其他用户的凭据ID。

  1. 在流控策略详情页面，单击“特殊应用”页签，进入特殊应用页面。
  2. 单击“添加特殊应用”，弹出“添加特殊应用”对话框。
  3. 通过以下两种方式，添加特殊应用。

    • 添加已有应用：单击“已有应用”，选择已有凭据名称，输入阈值。
    • 添加其他应用：单击“其他”，输入其他用户的凭据ID和阈值。

    阈值不能大于“API流量限制”值，且必须为正整数。

添加特殊租户

  1. 在流控策略详情页面，单击“特殊租户”，进入特殊租户页面。
  1. 单击“添加特殊租户”，弹出“添加特殊租户”对话框。
  2. 输入租户信息。

    图1 添加特殊租户
    表2 特殊租户信息

    信息项

    描述

    租户ID
    • 绑定华为IAM认证的API时，租户ID填写API调用者的账号ID。
    • 绑定APP认证的API时，租户ID填写APP所属者的项目ID。

    您可以单击控制台右上角的用户名，选择“我的凭证”，在我的凭证页面获取用户的项目ID和账号ID。

    阈值

    “时长”时间内，此租户访问单个API次数的最大值。

    不能大于“API流量限制”值。

  3. 单击“确定”，完成特殊租户的添加。
父主题： API策略

相关文档