预热查询 下载PDF文档

接口地址

请求URL: cache/prefetch (GET)

接口请求域名: cdn.api.baishan.com
接口版本: v2

接口描述

预热url的状态查询，频率限制见响应（response header）
注意: 预热的任务记录仅保留一个月, 相关url的预热状态请在该时间内做好查询保存

输入参数

以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，公有参数：用户的 token 可向值班同事获取

请求参数(GET)

参数添加到在url的query部分，例如: ?key1=value1&key2=value2

调用示例:

通过任务ID查询
curl 'https://cdn.api.baishan.com/v2/cache/prefetch?token=xx&task_id=30042314'

通过时间区间查询
curl -X GET "https://cdn.api.baishan.com/v2/cache/prefetch?token=xxx&start_time=2018-02-23&end_time=2018-02-23&page_number=1"

查询某条URL的状态
curl -X GET "https://cdn.api.baishan.com/v2/cache/prefetch?token=xxx&start_time=2018-02-24&end_time=2018-02-24&page_number=1&url=http://abc.qingcdn.com/domain/fun/info"

返回示例

json格式

{
    "code": 0,//code为0表示请求正常/成功，
    "message":"", //code非0时, 表示请求异常, 会增加该字段, 对该错误描述
    "data": {
        "total": 1,
        "page_number": 1,
        "list": [
            {
                "id": 3251371549,
                "url": "http://portal.qingcdn.com/theme/bsc1.7/images/logo.png",
                "status": "completed", //status为 completed:完成, waiting:待处理, processing:处理中, failed:处理失败
                "create_time": "2023-08-01 18:00:00",
                "complete_time": "2023-08-01 18:00:00" //status为completed时返回时间，否则返回空值。
            }
        ]
    }
}

示例参数:

{
    "start_time": "2018-02-09",
    "end_time": "2018-02-09",
    "url": "http://portal.qingcdn.com/theme/bsc1.7/images/logo.png"
}

响应(Response Header)

HTTP/1.0 200 OK
Api-Id:                70945467
Content-Type:          application/json; charset=utf-8
X-Ratelimit-Grad:      minute  //接口调用频率限制粒度(分/小时/天)
X-Ratelimit-Limit:     150  //当前每分钟请求次数上限
X-Ratelimit-Remaining: 99   //每分钟剩余请求次数
X-Retry-After:         31  //xx秒后重置当前粒度(分/小时/天)请求次数限制

http状态码说明