刷新 URL

最近更新时间:2020-09-02 08:05:26

1. 接口描述

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

PurgeUrlsCache 用于批量提交 URL 进行刷新,根据 URL 中域名的当前加速区域进行对应区域的刷新。 默认情况下境内、境外加速区域每日 URL 刷新额度各为 10000 条,每次最多可提交 1000 条。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:PurgeUrlsCache。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
Urls.N Array of String URL 列表,需要包含协议头部 http:// 或 https://
Area String 刷新区域
无此参数时,默认刷新加速域名所在加速区域
填充 mainland 时,仅刷新中国境内加速节点上缓存内容
填充 overseas 时,仅刷新中国境外加速节点上缓存内容
指定刷新区域时,需要与域名加速区域匹配

3. 输出参数

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

4. 示例

示例1 提交 URL 刷新任务

输入示例

https://cdn.tencentcloudapi.com/?Action=PurgeUrlsCache
&Urls.0=http://www.test.com/1.jpg
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdnConfigError 域名配置更新失败。
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnHostInvalidStatus 域名状态不合法。
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
InvalidParameter.CdnPurgeWildcardNotAllowed 刷新不支持泛域名。
InvalidParameter.CdnStatInvalidDate 日期不合法,请参考文档中日期示例。
InvalidParameter.CdnUrlExceedLength URL 超过限制长度。
LimitExceeded.CdnPurgeUrlExceedBatchLimit 刷新的Url数量超过限制。
LimitExceeded.CdnPurgeUrlExceedDayLimit 刷新的Url数量超过每日限额。
ResourceNotFound.CdnHostNotExists 账号下无此域名,请确认后重试。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
ResourceUnavailable.CdnHostIsNotOnline 域名已下线,无法提交预热。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。
UnauthorizedOperation.CdnUserAuthFail CDN用户认证失败。
UnauthorizedOperation.CdnUserAuthWait CDN用户待认证。
UnauthorizedOperation.CdnUserIsSuspended 加速服务已停服,请重启加速服务后重试。
UnauthorizedOperation.OpNoAuth 暂不支持此操作,请联系腾讯云工程师处理。
目录