全部产品

API 限流

更新时间:2020-10-13 11:27:44

API 限流指对某一 API 的访问量进行限制,避免高峰期时后台服务器被压垮。

前置条件

要使用限流配置,确保在 网关管理 页面,API 限流 功能开启:

  1. 登录 mPaaS 控制台。在左侧导航栏,点击 移动网关
  2. 点击 网关管理 标签,确保 API 限流 按钮开启。

关于此任务

限流配置包括限流模式、限流值、限流响应:

  • 限流模式

    • 关闭:不限制 API 调用。
    • 拦截:当调用频次超过限流值,拦截请求。
  • 限流值

    根据业务需求设置合理的限流阈值(单位:秒)。限流模式为拦截且超过此值时,请求会被限流。

  • 限流响应

    限流默认的响应为:{"resultStatus":1002,"tips":"顾客太多,客官请稍候"}

    如需定制限流响应,使用如下格式:

    1. {
    2. "result": "==此处为定制响应内容,请填写==",
    3. "tips": "ok",
    4. "resultStatus": 1000
    5. }

    其中,

    • result 为定制的响应数据,JSON 格式。只有 resultStatus 为 1000 时,客户端才会取此字段处理。
    • tips 为定制的限流提示。若 resultStatus 为 1002,会取此字段提示用户。
    • resultStatus 为限流返回的结果码,具体含义请参见 网关结果码