配置指南

API 文档

刷新目录

最近更新时间:2021-03-16 08:04:07

我的收藏

1. 接口描述

接口请求域名: cdn.tencentcloudapi.com 。

PurgePathCache 用于批量提交目录刷新,根据域名的加速区域进行对应区域的刷新。 默认情况下境内、境外加速区域每日目录刷新额度为各 100 条,每次最多可提交 20 条。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:PurgePathCache。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
Paths.N Array of String 目录列表,需要包含协议头部 http:// 或 https://
FlushType String 刷新类型
flush:刷新产生更新的资源
delete:刷新全部资源
UrlEncode Boolean 是否对中文字符进行编码后刷新

3. 输出参数

参数名称 类型 描述
TaskId String 刷新任务 ID,同一批次提交的目录共用一个任务 ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 提交目录刷新任务

输入示例

https://cdn.tencentcloudapi.com/?Action=PurgePathCache
&Paths.0=http://www.test.com/test/
&FlushType=flush
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "4d5a83f8-a61f-445b-8036-5636be640bef",
    "TaskId": "1533045796-i60rfmzm"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.InvalidAuthorization 鉴权错误,请确认后重试。
InternalError.CdnConfigError 域名配置更新失败。
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnQueryParamError 内部查询错误,请重试或联系客服人员解决。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InternalError.Error 内部服务错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnHostInvalidStatus 域名状态不合法。
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
InvalidParameter.CdnPurgeWildcardNotAllowed 刷新不支持泛域名。
InvalidParameter.CdnStatInvalidDate 日期不合法,请参考文档中日期示例。
InvalidParameter.CdnUrlExceedLength URL 超过限制长度。
LimitExceeded.CdnPurgePathExceedBatchLimit 刷新的目录数量超过限制。
LimitExceeded.CdnPurgePathExceedDayLimit 刷新的目录数量超过每日限制。
ResourceNotFound.CdnHostNotExists 账号下无此域名,请确认后重试。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。
UnauthorizedOperation.CdnUserAuthFail CDN用户认证失败。
UnauthorizedOperation.CdnUserAuthWait CDN用户待认证。
UnauthorizedOperation.CdnUserIsSuspended 加速服务已停服,请重启加速服务后重试。
UnauthorizedOperation.OperationTooOften 操作超出调用频次限制。
目录