更新时间:2024-08-05 GMT+08:00

配置API调用流控策略

操作场景

DataArts Studio数据服务的API流量控制基于指定规则对API的访问流量进行调节控制的限流策略,能够提供多种维度的后端服务保护功能。当前API流控支持通过用户、应用和时间段等不同维度限制API的调用次数。

为了提供持续稳定的服务,您需要通过创建并选择流控策略,针对部分API进行流量控制。流控策略和API本身是相互独立的,只有将流控策略绑定API后,流控策略才对绑定的API生效。

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

前提条件

需要绑定的API已发布。

创建流控策略

  1. DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
  1. 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
  2. 单击“运营管理 > 流控策略”,进入到流量控制信息页面。
  3. 单击“创建流控策略”,弹出“创建流控策略”对话框。输入如表1所示信息。
    图1 创建流控策略
    表1 流控策略信息

    信息项

    描述

    策略名称

    API流控策略名称。

    时长

    流量限制的时长。

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

    API流量限制

    单个API被调用次数上限。

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

    用户流量限制

    单个用户调用API次数上限。

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

    应用流量限制

    单个应用调用API次数上限。

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

    描述

    关于控制策略的描述。

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

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

绑定API

  1. DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
  1. 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
  2. 单击“运营管理 > 流控策略”,进入到流量控制信息页面。
  3. 通过以下任意一种方法,进入“绑定API”页面。
    • 在待绑定的流量控制策略所在行,单击“绑定API”。
    • 单击策略名称,进入策略详情页面。在“绑定的API列表”页签中单击“绑定API”。
  4. 选择“API分组”和“API名称”,筛选所需的API。
  5. 勾选API,单击“绑定”,完成API绑定策略。

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

删除流控策略

当已创建的流控策略不再提供服务时,可以将此流控策略删除。

  1. DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
  1. 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
  2. 单击“运营管理 > 流控策略”,进入到流量控制信息页面。
  3. 在待删除的流控策略所在行,单击“删除”。
    • 仅在流控策略未绑定任何API时,支持删除,否则请先解绑API。
    • 如果需要批量删除流控策略,则勾选待删除的流控策略,单击“删除”。最多同时删除1000个流控策略。
  4. 单击“确定”,完成流控策略的删除。