文件预热接口


请求地址

https://api.upyun.com/preheat/

HTTP请求方法

POST

是否需要登陆授权

是,关于登录授权,参见授权机制

请求参数

必选 数据类型及范围 说明
url true string 待预热url

url 说明:

参数取值 说明
待预热url 以换行符号(\n)分割

返回结果

{
    "result": [
        {
            "url": "testmycdn.b0.upaiyun.com/aa.jpg", 
            "status": "URL 格式错误", 
            "code": 4
        }, 
        {
            "url": "http://testmycdn2.b0.upaiyun.com/bb.jpg", 
            "status": "该域名并不属于您", 
            "code": 5
        }, 
        {
            "url": "http://testmycdn2.b0.upaiyun.com/cc.jpg", 
            "status": "未处理", 
            "code": 3
        }
    ]
}

当且仅当预热成功时返回的数据里包含 task_id 以供查询预热进度

{
    "result": [
        {
            "url": "http://testmycdn.b0.upaiyun.com/aa.jpg", 
            "status": "预热成功", 
            "task_id": "e10adc3949ba59abbe56e057f20f883e", 
            "code": 1
        }, 
        {
            "url": "http://testmycdn2.b0.upaiyun.com/bb.jpg", 
            "status": "预热失败", 
            "code": 2,
            "task_id": null
        }
    ]
}

注意:返回结果中包括所有域名。

假如,url中有一条格式错误或者是其他原因报错,那所有url都不会加入预热,返回结果会有说明;

假如,url没有报错,那返回结果会返回所有已经预热成功和预热失败的结果。现结果中加入code代码,方便判断。

code说明

code 说明
1 预热成功
2 预热失败
3 未处理
4 格式错误
5 不属于您的url

错误返回值与错误代码,参见错误代码说明

Last edited by hubiao, 2016-07-06 18:41:31