文档

API 流量治理

更新时间:
一键部署

在 API 详情页,您可以对该 API 进行流量治理,即配置限流与缓存。

限流

限流指对网关到后端集群的请求进行限制。操作步骤如下:

说明

目前 API 网关仅支持单机限流,即对经过网关单容器(非集群)到后端集群的请求进行限制。

  1. 在 API 详情页,切换至 流量治理 标签页。

  2. 单击 限流 右侧图标,开始编辑具体限流配置:

    • 限流状态:将状态切换为 状态。

    • 阈值(QPS):表示单位时间内允许通过最大请求数的值,超过该数值的请求会被限流,仅支持正整数。

    • 异常响应类型:支持选择 返回数据网关响应码返回 两个选项。

  3. 单击 确认

缓存

缓存是指网关将后端的内容缓存在网关上,降低对后端 Server 的压力。

操作步骤如下:

  1. 在 API 详情页,切换至 流量治理 标签页。

  2. 单击 缓存 右侧图标,开始编辑具体限流配置:

    • 结果缓存:将状态切换为 状态。

    • 缓存时间:将内容缓存在网关上的时间,单位为秒(s)。最长支持 5 分钟。

    • 缓存键值:需要配置缓存键值位置与具体缓存键值,支持从 HEADER、QUERY、COOKIE 和 BODY 中进行选择。

      说明

      如果选择 BODY,BODY 必须是一个 JSON 字符串,暂时不支持 pb 格式的 BODY。

  3. 单击 确认