预热 URL

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

1. 接口描述

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

PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点,支持指定加速区域预热。 默认情况下境内、境外每日预热 URL 限额为各 1000 条,每次最多可提交 20 条。 接口灰度中,暂未全量开放,敬请期待。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:PushUrlsCache。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
Urls.N Array of String URL 列表,需要包含协议头部 http:// 或 https://
UserAgent String 指定预热请求回源时 HTTP 请求的 User-Agent 头部
默认为 TencentCdn
Area String 预热生效区域
mainland:预热至境内节点
overseas:预热至境外节点
global:预热全球节点
不填充情况下,默认为 mainland, URL 中域名必须在对应区域启用了加速服务才能提交对应区域的预热任务
Layer String 填写"middle"或不填充时预热至中间层节点

3. 输出参数

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

4. 示例

示例1 预热 URL

输入示例

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

输出示例

{
  "Response": {
    "RequestId": "123",
    "TaskId": "15475444535871929928456"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdnConfigError 域名配置更新失败。
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnHostInvalidMiddleConfig 错误的中间源配置。
InvalidParameter.CdnHostInvalidParam 域名格式不合法,请确认后重试。
InvalidParameter.CdnHostInvalidStatus 域名状态不合法。
InvalidParameter.CdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
InvalidParameter.CdnPushWildcardNotAllowed 预热不支持泛域名。
InvalidParameter.CdnStatInvalidDate 日期不合法,请参考文档中日期示例。
InvalidParameter.CdnStatInvalidProjectId 项目ID错误,请确认后重试。
LimitExceeded.CdnHostOpTooOften 域名操作过于频繁。
LimitExceeded.CdnPushExceedBatchLimit 预热的Url数量超过单次限制。
LimitExceeded.CdnPushExceedDayLimit 预热的Url数量超过每日限制。
ResourceInUse.CdnOpInProgress CDN资源正在被操作中。
ResourceNotFound.CdnHostNotExists 账号下无此域名,请确认后重试。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
ResourceUnavailable.CdnHostIsLocked 域名被锁定。
ResourceUnavailable.CdnHostIsNotOnline 域名已下线,无法提交预热。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。
UnauthorizedOperation.CdnUserAuthFail CDN用户认证失败。
UnauthorizedOperation.CdnUserAuthWait CDN用户待认证。
UnauthorizedOperation.CdnUserIsSuspended 加速服务已停服,请重启加速服务后重试。
UnauthorizedOperation.CdnUserNoWhitelist 非内测白名单用户,无该功能使用权限。
UnauthorizedOperation.OpNoAuth 暂不支持此操作,请联系腾讯云工程师处理。
目录