API 频率限制

介绍

BosonNLP API 根据不同的认证用户有不同的频率限制。该限制主要针对用户上传的篇数以及 API 调用次数。

每次 API 请求返回的 HTTP header 里包括了该 API 限制的详细信息,详情看 这里。也可以通过rate limit接口来查询用户所有 API 限制的详细信息。

篇数
一天上传文档的数量,东八区每天 0 点重置
次数
每15分钟调用接口次数,一次http请求为调用一次该接口

Note

每15分钟重置时间为每小时的0分,15分,30分,45分。

查询接口介绍

本接口用来查询用户使用 BosonNLP API 频率限制的详细信息。

URL
http://api.bosonnlp.com/application/rate_limit_status.json
HTTP Method
GET
HTTP Header
X-Token
YOUR_API_TOKEN (需要替换成您自己的 Token)
HTTP 返回 Body
返回 JSON 格式的状态信息

CURL 调用示例

$ curl -H "X-Token: YOUR_API_TOKEN" http://api.bosonnlp.com/application/rate_limit_status.json

Python 调用示例

# -*- encoding: utf-8 -*-
import requests

# 注意:在测试时请更换为您的API Token
HEADERS = {'X-Token': 'YOUR_API_TOKEN'}
RATE_LIMIT_URL = 'http://api.bosonnlp.com/application/rate_limit_status.json'

result = requests.get(RATE_LIMIT_URL, headers=HEADERS).json()

返回结果说明

{
"limits": {
    "classify": {                              //API名称
        "count-limit-limit": 3000000,         //今天可上传文档的篇数总量
        "count-limit-remaining": 3000000,     //今天剩余可上传文档的篇数
        "count-limit-reset": 1399910400,      //今天重置上传文档篇数限制的剩余时间
        "rate-limit-limit": 50000,            //15分钟内可调用接口总次数
        "rate-limit-remaining": 50000,        //15分钟内剩余可调用接口次数
        "rate-limit-reset": 1399868100         //15分钟内调用次数限制的重置时间
    }...
字段 类型 说明
count-limit-limit int 今天可上传文档的篇数总量,一天的开始从东八区的 0 点开始计算
count-limit-remaining int 今天剩余可上传文档的篇数
count-limit-reset unix timestamp 今天重置上传文档篇数限制的剩余时间
rate-limit-limit int 15分钟内可调用接口总次数
rate-limit-remaining int 15分钟内剩余可调用接口次数
rate-limit-reset unix timestamp 重置调用次数限制的剩余时间

API 调用失败说明

用户遇调用API次数受限制时会遇到如下HTTP返回信息:

{"status":429,"message":"count/rate limit exceeded"}

请确认 X-Count-Limit-RemainingX-Rate-Limit-Remaining 还有剩余调用量,否则要等待相应的重置时间才可以继续调用API。

X-Count-Limit-Remaining 为 0 时,东八区 0 点重置。

X-Rate-Limit-Remaining 为 0 时,参考前文 API 调用次数重置时间。