一键刷新预热

最近更新时间:2018-11-08 09:47:14

接口描述

FlushOrPushOverall 用于一次性同时刷新或预热境外、大陆资源。

请求域名:cdn.api.qcloud.com

注意事项:

  • 提交预热请求前请确保账户已经开通预热白名单
  • 提交刷新/预热任务时,请确保加速域名已经在指定区域(大陆/境外)接入,并处于【已启用】或【部署中】状态
  • 提交的URL列表需要以 http:// 或是 https:// 开头
  • 刷新/预热每次、每日使用均有限额,您可以前往CDN控制台查看您的限额情况
  • 调用频次限制为 100次/分钟
  • 接口暂不支持子账号调用

查看调用示例

入参说明

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的 Action 字段为 FlushOrPushOverall。

参数名称 是否必选 类型 描述
command String 指定要进行的操作
"push":表示预热
"flush 表示刷新
urls String 提交的刷新/预热URL清单
type String 刷新/预热类型
"dir":表示目录
"url": 表示资源全路径
预热暂时不支持目录方式
mainland Int 填充 1 表示刷新/预热大陆
若不填充则表示大陆无提交操作
oversea Int 填充 1 表示刷新/预热境外
若不填充则表示境外无提交操作

详细说明

mainland 和 oversea 参数必须有一个填充 1,才可成功提交。

出参说明

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。
详见错误码页面公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误信息,或业务侧错误码。
详见错误码页面业务错误码

调用案例

示例参数

command:flush
urls.0:https://www.test.com/1.jpg
type:url
mainland:1

GET 请求

GET 请求需要将所有参数都加在 URL 后(key=value形式,value需要进行URL encode):

https://cdn.api.qcloud.com/v2/index.php?
Action=FlushOrPushOverall
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
&Nonce=123456789
&Timestamp=1511794466
&command=flush
&urls.0=https%3A%2F%2Fwww.test.com%2F1.jpg
&type=url
&mainland=1
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX

POST请求

POST请求时,参数填充在HTTP Requestbody中,请求地址:

https://cdn.api.qcloud.com/v2/index.php

参数支持 formdata等格式,参数数组如下:

array (
    'Action' => 'FlushOrPushOverall',
    'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
    'Timestamp' => 1511794466,
    'Nonce' => 123456789,
    'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
    'command' => ''flush",
    'urls.0' => 'https://www.test.com/1.jpg',
    'type' => 'url',
    'mainland' => '1'
)

返回示例

{
    "code": 0,
    "message": "",
    "codeDesc": "Success"
}