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 时，仅刷新中国境外加速节点上缓存内容 指定刷新区域时，需要与域名加速区域匹配 示例值：mainland |
| UrlEncode | 否 | Boolean | 是否对中文字符进行编码后刷新 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 刷新任务 ID，同一批次提交的 URL 共用一个任务 ID 示例值：123456 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.InvalidAuthorization | 鉴权错误，请确认后重试。 |
| InternalError.CamSystemError | 内部鉴权系统错误。 |
| InternalError.CdnConfigError | 域名配置更新失败。 |
| InternalError.CdnDbError | 内部数据错误，请联系腾讯云工程师进一步排查。 |
| InternalError.CdnQueryParamError | 内部查询错误，请重试或联系客服人员解决。 |
| InternalError.CdnQuerySystemError | 内部查询错误，请重试或联系客服人员解决。 |
| InternalError.CdnSystemError | 系统错误，请联系腾讯云工程师进一步排查。 |
| InternalError.Error | 内部服务错误，请联系腾讯云工程师进一步排查。 |
| InternalError.ProxyServer | 内部服务错误，请联系腾讯云工程师进一步排查。 |
| InternalError.RouteError | 内部服务错误，请联系腾讯云工程师进一步排查。 |
| InternalError.UnknownError | 内部服务错误，请联系腾讯云工程师进一步排查。 |
| InvalidParameter.CdnHostInvalidStatus | 域名状态不合法。 |
| InvalidParameter.CdnInterfaceError | 内部接口错误，请联系腾讯云工程师进一步排查。 |
| InvalidParameter.CdnParamError | 参数错误，请参考文档中示例参数填充。 |
| InvalidParameter.CdnPurgeWildcardNotAllowed | 刷新不支持泛域名。 |
| InvalidParameter.CdnStatInvalidDate | 日期不合法，请参考文档中日期示例。 |
| InvalidParameter.CdnUrlExceedLength | URL 超过限制长度。 |
| LimitExceeded.CdnPurgeExceedBatchLimit | 刷新的Url数量超过每批提交的限制。 |
| LimitExceeded.CdnPurgeExceedDayLimit | 刷新的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.EcdnMigratedCdn | 请前往CDN控制台进行操作。 |
| UnauthorizedOperation.OpNoAuth | 暂不支持此操作，请联系腾讯云工程师处理。 |
| UnauthorizedOperation.OperationTooOften | 操作超出调用频次限制。 |
