更新时间:2024-01-15 GMT+08:00

创建流控策略

操作场景

流量控制可限制单位时间内API的被调用次数,保护后端服务。

为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。

流控策略和API本身是相互独立的,只有将流控策略绑定API后,流控策略才对绑定的API生效。

  • 同一个环境中,一个API只能被一个流控策略绑定,但一个流控策略可以绑定多个API。
  • 如果API未绑定流控策略,共享版API网关系统默认流控限制为200次/秒。专享版API网关流控限制值为实例“配置参数”中“ratelimit_api_limits”的参数运行值。

前提条件

需要绑定的API已发布

创建流控策略

  1. 登录管理控制台。
  2. 在管理控制台左上角单击,选择区域。
  3. 单击管理控制台左上角,然后单击“API网关 APIG”。
  4. 在左侧选择您的API版本,单击并进入到对应版本的API开发与调用管理页面。

    • “共享版”指直接创建并管理API,如涉及到费用,以API调用次数计费。
    • “专享版”指在API专享版实例中创建并管理API,如涉及到费用,按实例运行时间计费。

  5. 选择“开放API > 流量控制”,进入到流量控制信息页面。
  6. 单击“创建流控策略”,弹出“创建流控策略”对话框。输入如表1所示信息。

    表1 流控策略信息

    信息项

    描述

    策略名称

    API流控策略名称。

    类型

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

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

    时长

    流量限制的时长。

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

    API流量限制

    单个API被调用次数上限。

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

    用户流量限制

    单个用户调用API次数上限,仅适用于API的安全认证方式为APP认证或IAM认证

    • 不超过“API流量限制”。
    • 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。
    • 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。

    应用流量限制

    单个应用调用API次数上限,仅适用于API的安全认证方式为APP认证

    • 不超过“用户流量限制”。
    • 与“时长”配合使用,表示单位时间内的单个应用请求次数上限。

    源IP流量限制

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

    • 不超过“API流量限制”。
    • 与“时长”配合使用,表示单位时间内的单个IP地址请求次数上限。

    描述

    关于控制策略的描述。

  7. 单击“确定”,完成流量控制策略的创建。

    创建成功后,流量控制页面增加显示新创建的策略。您可以将相关API绑定到该策略,以实现流量控制。

绑定API

  1. 在“流量控制”页面,通过以下任意一种方法,进入“绑定API”页面。

    • 在待绑定的流量控制策略所在行,单击“绑定API”,进入已绑定API列表页面。单击“绑定API”。
    • 单击策略名称,进入策略详情页面。在“绑定的API列表”页签中单击“绑定API”。

  2. 选择“API分组”、“环境”以及“API名称”,筛选所需的API。
  3. 勾选API,单击“绑定”,完成API绑定策略。

    图1 绑定API

    在流控策略绑定API后,如果API不需要调用此策略,单击“解除”,解除绑定。如果需要批量解绑API,则勾选待解绑的API,单击“解除”。最多同时解绑1000个API。

使用API方式创建流控策略、绑定API和解除绑定

您还可以使用API的方式创建流控策略、绑定API和解除绑定,具体操作请查看以下链接。

创建流控策略

绑定流控策略

解除绑定

后续操作

  • 如果某个应用希望受流量策略控制,可以通过对该策略增加特殊应用实现,具体参考添加特殊应用或租户。增加特殊应用后,此应用的应用流量受特殊应用的阈值限制,而API流量和用户流量受流量策略限制。
  • 如果某个租户希望受流量策略控制,可以通过对该策略增加特殊租户实现,具体参考添加特殊应用或租户。增加特殊租户后,此租户的用户流量受特殊租户的阈值限制,而API流量和应用流量受流量策略限制。