刷新目录

最近更新时间:2018-11-22 16:45:00

接口描述

RefreshCdnDir用于将 CDN 全网节点上指定目录下的资源设置为过期。
请求域名:cdn.api.qcloud.com

  • 默认情况下,每一个账号每日可刷新目录100条,每次最多可提交20条。
  • 全网目录刷新生效时间约为5分钟。
  • 提交目录的 URL 必须以http://https://开头。
  • 提交目录的 URL中域名必须为该账号下接入的加速域名。
  • 提交目录的 URL 中域名的状态需要为【已启动】或【部署中】。
  • 选择目录刷新类型 "1",会比对节点内容与源站内容的 Last-Modify,若未变化,则不会进行资源刷新。
  • 选择目录刷新类型 "2",会直接删除目录下所有资源,此操作会导致源站压力增大,请谨慎操作。
  • 调用频次限制为3000次/分钟。
  • 接口已支持子账号调用,权限配置可参考权限 配置示例

查看 调用示例

入参说明

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

参数名称 是否必选 类型 描述
dirs.n String 需要刷新的目录
详情请参见下文 “目录详细说明”
type Int 目录刷新类型,不填充默认为1
"1":刷新更新资源
"2":刷新全部资源

目录详细说明

支持一个或多个目录刷新,参数传入方式可参考:

dirs.0=http://www.test.com/abc/&dirs.1=http://www.test.com/def/

出参说明

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

调用案例

示例参数

dirs.0:http://www.test.com/test/

GET 请求

GET 请求需要将所有参数都加在 URL 后:

https://cdn.api.qcloud.com/v2/index.php?
Action=RefreshCdnDir
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462521628
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&dirs.0=https%3A%2F%2Fwww.test.com%2Ftest

注意:

GET 请求大小限制为32KB,超出大小限制则会返回状态码501。若需提交较多 URL,可采用 POST 请求。

POST 请求

POST请求时,参数填充在 HTTP Request-body 中,请求地址:

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

参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:

array (
  'Action' => 'RefreshCdnDir',
  'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXX',
  'Timestamp' => 1462865178,
  'Nonce' => 279749933,
  'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  'dirs.0' => 'http://www.test.com/test/'
)

注意:

POST 请求大小限制为1MB,超出大小限制则会返回状态码501。若需提交较多 URL,请拆分为多批次提交。

结果示例

{
    "code": 0,
    "message": "",
    "codeDesc": "Success"
}
{
    "code": 4000,
    "message": "(9110)没有这个域名的信息 cdn no such host",
    "codeDesc": 9110
}