Skip to content

规则管理 ​

功能概述 ​

项目内容
适用角色运营管理员
导航路径设置 > API 流控 > 规则管理
页面路由/user/system/rate-control/rules
管理对象API 流控规则、API Pattern、规则状态和发布状态

新手理解 ​

规则管理页像 API 流控规则库,用来配置哪些接口在什么条件下统计或拦截。规则发布前应先确认匹配范围、阈值和灰度影响。

术语速查 ​

术语说明
流控规则限制或统计 API 请求的规则;发布前确认匹配范围。
阈值触发统计或拦截的请求上限;过低可能误伤业务。
统计模式只记录超限但不拦截的模式;上线前可先观察。
发布将规则同步到节点的动作;发布后查看节点缓存。

前提条件 ​

  1. 当前账号具备 API 流控规则管理权限。
  2. 已进入 API 流控 > 规则管理。
  3. 发布规则前已完成规则范围和影响评估。

页面说明 ​

页面提供规则筛选、规则列表和生命周期操作,用于新增、查看、编辑、启停及删除流控规则。

规则管理

区域说明
刷新刷新规则列表。
新建规则新增流控规则入口。
发布全部规则版本发布当前规则版本到节点。
规则名称按规则名称筛选。
API Pattern按 API 匹配模式筛选。
规则表格展示规则、计数范围、模式、额度、窗口、优先级、发布、启用和操作。

主要操作 ​

查看流控规则 ​

  1. 进入 设置 > API 流控 > 规则管理。
  2. 按名称、状态、作用域、动作或更新时间筛选规则。
  3. 打开详情,核对匹配条件、阈值、动作、优先级、适用节点和版本。
  4. 无结果时重置筛选;规则命中异常时对照观测审计和当前发布版本。

创建流控规则 ​

  1. 进入 设置 > API 流控 > 规则管理。
  2. 点击 "新建规则"、新建流控规则 或页面真实新增入口。
  3. 在新建规则页面或弹窗中查看规则配置字段。

新建流控规则

  1. 填写规则名称、接口路径、请求方法、匹配条件、限流阈值和时间窗口。
  2. 根据页面字段选择生效范围、结果处理方式、启用状态或优先级。
  3. 点击最终 保存、提交 或 发布 前,确认规则不会误拦截正常业务请求。
  4. 如仅学习或截图,只查看字段并点击 "取消" 或返回,不提交真实规则配置。

编辑流控规则 ​

  1. 进入 设置 > API 流控 > 规则管理。
  2. 定位目标规则管理,点击 "编辑"。
  3. 按页面显示的必填字段完成查看或填写,并核对目标对象、影响范围和当前状态。
  4. 对会改变数据、权限、状态或外部配置的操作,确认影响范围和回退方式后再点击最终确认按钮。
  5. 操作完成后返回列表或详情页,核对状态、更新时间或结果提示。

复制流控规则 ​

  1. 进入 设置 > API 流控 > 规则管理。
  2. 定位目标规则管理,点击 "复制"。
  3. 按页面显示的必填字段完成查看或填写,并核对目标对象、影响范围和当前状态。
  4. 对会改变数据、权限、状态或外部配置的操作,确认影响范围和回退方式后再点击最终确认按钮。
  5. 操作完成后返回列表或详情页,核对状态、更新时间或结果提示。

发布流控规则 ​

  1. 进入 设置 > API 流控 > 规则管理。
  2. 定位目标规则管理,点击 "发布全部规则"。
  3. 按页面显示的必填字段完成查看或填写,并核对目标对象、影响范围和当前状态。
  4. 对会改变数据、权限、状态或外部配置的操作,确认影响范围和回退方式后再点击最终确认按钮。
  5. 操作完成后返回列表或详情页,核对状态、更新时间或结果提示。

参数速查表 ​

字段名称是否必填字段类型示例说明
规则名称是文本示例规则 A用于识别流控规则。
接口路径是文本<ENDPOINT_PATH>规则匹配的接口路径,文档中必须脱敏。
请求方法否枚举GET规则匹配的 HTTP 请求方法。
匹配条件是条件表达式tenant = example规则命中的条件组合。
限流阈值是数值100 次/分钟触发统计或拦截的请求上限。
时间窗口是时间1 分钟统计请求次数的时间窗口。
生效范围是枚举 / 多选全局规则适用的接口、租户、用户或服务范围。
处理方式是枚举拦截规则命中后的处理策略。
启用状态是枚举启用判断规则是否参与流控。
优先级否数字10多条规则同时匹配时的处理顺序。
操作系统生成按钮编辑 / 复制 / 发布 / 删除提供规则后续维护入口。

踩坑提示 ​

  • 不要直接把新规则全量发布,先确认匹配路径和阈值。
  • 规则发布成功不代表所有节点立即同步,应查看节点缓存和发布中心。
  • 拦截异常升高时,先看观测审计再调整规则。
  • 新建或发布流控规则会影响真实 API 访问、用户请求成功率和业务可用性。
  • 错误接口路径、匹配条件、阈值或时间窗口可能导致正常请求被误拦截。
  • 保存、提交、发布、发布全部、禁用、删除 属于高风险动作。
  • 不在文档中写真实接口路径、Token、账号、租户 ID、客户名、内部错误详情或压测参数。

结果校验 ​

检查项成功表现异常时处理
规则筛选列表按名称或 API Pattern 刷新。检查筛选条件。
状态可见发布状态和启用状态正常展示。刷新规则列表。
发布记录发布后可在发布中心查看记录。进入发布中心核对。
新建入口点击 "新建规则" 后可打开新建规则页面或弹窗。检查当前账号是否具备规则创建权限。

常见问题 ​

新规则发布后不生效 ​

问题现象:

规则已配置,但请求没有被统计或拦截。

可能原因:

规则未发布到节点、启用状态不正确,或 API Pattern 未匹配目标请求。

处理方式:

确认规则启用和发布状态,再进入节点缓存和观测审计核对。

发布全部规则前要检查什么 ​

问题现象:

页面提供 发布全部规则版本 入口。

可能原因:

发布会影响 API 流控策略在节点上的生效版本。

处理方式:

先确认规则差异、影响 API 和回退方案,再由具备权限的人员发布。

为什么看不到限流规则? ​

问题现象:

规则管理页没有展示预期的租户、模型或 API 限流规则。

可能原因:

规则创建在其他范围,规则已停用,或当前账号缺少 API 频控规则查看权限。

处理方式:

清空规则类型、状态和租户筛选;确认规则生效范围;仍不可见时由频控管理员检查规则配置和发布状态。

如何安全导出或截图规则管理页面? ​

问题现象:

需要把页面信息用于排障、审计或交付。

可能原因:

页面可能包含账号、邮箱、IP、内部路径、租户标识、Key 或金额等敏感信息。

处理方式:

只保留必要字段和操作上下文,使用浅灰小颗粒马赛克覆盖敏感文字,不外发完整凭证或内部地址。

规则管理页面出现异常数据怎么办? ​

问题现象:

字段、状态、统计或关联对象与预期不一致。

可能原因:

页面范围、时间条件、角色权限或上游配置不一致。

处理方式:

记录脱敏后的对象、时间和结果,先核对页面入口及筛选条件,再查看关联页面和操作日志。

注意事项 ​

  • API Pattern 配置过宽可能误伤正常请求。
  • 发布和启用规则前应确认影响范围和回退方式。
  • 保存、提交、发布、发布全部、禁用、删除 属于高风险动作。
  • 不在文档中写真实接口路径、Token、账号、租户 ID、客户名、内部错误详情或压测参数。

后续操作 ​

  1. 查看流控趋势,进入 Overview。
  2. 查看节点缓存,进入 节点缓存。
  3. 查看发布结果,进入 发布中心。