帮助与文档

刷新查询 下载PDF文档

接口地址

请求URL: cache/refresh (GET)

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

接口描述

刷新url的状态查询,频率限制见响应(response header)
注意: 刷新的任务记录仅保留一个月(单次查询跨度7天), 相关刷新状态请在该时间内做好查询保存

输入参数

公有参数:用户的 token 可向值班同事获取

请求参数(GET)

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

参数名数据类型是否必须说明
start_timestringstart_time, 起始时间: 例如2018-02-11, [star_time,end_time,url]三个参数组合为一种查询方式, 与task_id查询方式互斥
end_timestringend_time, 结束时间: 例如2018-02-11
urlstring需要查询刷新状态的url, 该参数为非必须
page_numberstring取得第几页, 默认1
page_sizestring分页大小, 默认50 ,值范围1-500
task_idint查询方式2: task_id查询, 查询单次提交的所有url的刷新状态

调用示例:

通过任务ID查询
curl -X GET "https://cdn.api.baishan.com/v2/cache/refresh?token=xx&task_id=2400008"

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

查询某条URL的状态
curl -X GET "https://cdn.api.baishan.com/v2/cache/refresh?token=xxx&start_time=2018-02-24&end_time=2018-02-24&page_number=100&url=http://abc.qingcdn.com/track/main/stat/bandwidth"

返回示例

json格式

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

            }
        ]
    }
}

响应(Response Header)

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

http状态码说明

错误状态码说明
404您输入的 URL 错误
401鉴权错误,您的token错误,或者没有开通接口权限
400请求参数有误
200执行成功,返回请求的数据
5xx请联系值班同事
CopyRight © 2015-2024 BaishanCloud . All Rights Reserved.