帮助与文档

URL一致性检查任务提交 下载PDF文档

接口地址

请求URL: cache/purgeCheck (POST)

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

接口描述

全网url资源校验接口
用于检验探测所有边缘节点上的相应资源是否不存在或者与源站一致,并返回一个对应的batch_id,在通过查询接口获得结果
注意:回测文件需小于100M

输入参数

请求参数(POST)

参数支持 form-data、x-www-form-urlencoded、json 等格式

参数名数据类型是否必须说明
urlsarray需要检验的urls列表,单次最大提交1000条url,每日提交默认最大5000条url
--urlstring需要检验的url,不支持目录
--srcstring回源地址,默认从回源配置中获取
--portint回源端口,1-65525
--schemestring回源协议,http/https
--hoststring回源host,默认从url获取

调用示例:

curl -X POST 'https://cdn.api.baishan.com/v2/cache/purgeCheck?token=xxxxx' \
--header 'Content-Type: application/json' \
-d '{
    "urls": [
        {
            "url": "https://www.a.com/s/wl/config/domainCfg/prod.json",
            "src": "127.0.0.1",
            "port": 443,
            "scheme": "https",
            "host": "www.a.com"
        }
    ]
}'

返回示例

x-cnc-request-id: 日志id,当对此次请求有疑问时,可提供此id给内部人员排查

batchId: 查询任务id,用于获取查询结果
json格式

{
    "code": 0,
    "data": {
        "x-cnc-request-id": "xxx-xxx-xxx",
        "batchId": "xxx-xxx-xxx"
    }
}

响应(Response Header)

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

http状态码说明

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