套餐限流状态查询

The guide below is in Chinese.

查询每份套餐当前配置的突发和周期限流。核对窗口中的 used 和 max,确认已经用了多少次。

一、查询接口

使用登录访问令牌。

Shell command
curl "https://staging-api.taotoken.io/api/v1/packages/my/rate-limits" \
  -H "Authorization: Bearer $TP_ACCESS_TOKEN"

返回一个数组,每项形如:

JSON
{
  "plan_instance_id": "…",
  "package_name": "…",
  "scene_type": "…",
  "burst":  { "used": 3, "max": 100, "window_hours": 1 },
  "weekly": { "used": 42, "max": 5000, "window_days": 7 }
}

如何读懂限流状态

请对照下表理解返回内容,尤其注意 used: null 与「没有限流」是完全不同的两件事:

你看到的含义
该套餐不在数组里三种可能原因(见下方 §三),不代表「没配限流」
在数组里,没有 burst/weekly 键这个套餐没有配置对应窗口的限流,即不限
有该键,used 是数字已配置限流,used 是窗口内已用次数
有该键,used 是 null限流用量的实时统计暂时读取失败,并不是「用量为 0」,也不代表「现在没有限流」

used: null 时限流本身仍在正常执行(限流由数据面在每次调用时实时执行),只是统计读数暂时不可用;请不要把它理解为「现在可以随便调」。

三、套餐「不在数组里」的三种原因

一个套餐没有出现在返回数组里,可能是以下任一情况:

  1. 该套餐实例状态不是有效中,或已过期
  2. 该套餐记录本身已不可获取
  3. 该套餐是按量计费类型——这类套餐用额度控制用量,不使用本页描述的双层窗口限流

三种情况在响应里表现完全相同(都是「不在数组里」),无法仅凭这一点反推出具体原因。

四、底层配置字段

限流配置挂在套餐上,包含两组窗口:

Code
突发窗口:窗口时长(小时)+ 该窗口内最大调用次数
周期窗口:窗口时长(天)+ 该窗口内最大调用次数

运行时用量统计由数据面在调用时维护,控制面只读不写。

4.1 配置入口目前不对称

  • 平台套餐:管理后台建包页提供限流编辑器,可以配置
  • 分销商自建套餐:目前不支持配置限流字段

分销商自建套餐目前没有这两项限流配置。

五、已知的一处行为

将限流次数上限设为 0(本意是「该窗口内完全禁止调用」)目前会被当作「未配置」处理,即渲染为不限流,且不会有任何报错提示。这是当前的已知行为,如果你依赖 0 表达「完全禁止」,请先与平台确认。

账户限流与套餐限流

查询账户整体额度请看调用频率限制。某份套餐未出现在结果里时,可先在工作台核实套餐状态。