全部产品
Search
文档中心

全站加速 DCDN:PreloadDcdnObjectCaches - 预热URL

更新时间:Mar 01, 2024

调用PreloadDcdnObjectCaches将源站的内容主动预热到L2 Cache节点上,用户首次访问可直接命中缓存,缓解源站压力。

接口说明

  • 相关接口:刷新预热类接口包含 RefreshDcdnObjectCaches 刷新接口和 PreloadDcdnObjectCaches 预热接口。

  • 请求方式:支持 POST 请求,参数用 form 表单显示。

  • URL 预热配额(每日):默认情况下,一个账号每日最多可以提交 1000 条 URL 预热任务,如果您账号的日带宽峰值大于 200 Mbps,可通过提交工单申请提升每日配额,阿里云将根据您业务的实际需求进行评估和配置。

  • 每次最多可以提交 100 条 URL 预热任务。

  • 预热队列规则:每个账号的预热队列最大为 100,000 条 URL,DCDN 根据 URL 提交的先后顺序进行预热,当预热队列中未完成的任务达到了 100,000 条 URL 时,阿里云 DCDN 将会采取排队机制(即完成排序最前的一条 URL 预热后才可以继续提交下一条 URL 预热)完成预热。

  • 单用户调用频率:15 次/秒。

注意事项

  • 提交预热任务并成功执行后,DCDN 节点会立即回源站加载所需资源,因此大批量提交预热任务会生成较多的并发下载任务,导致回源带宽和请求突增,增加源站压力。
  • 预热任务从提交到预热完成,实际执行时间视预热文件大小而定,大约需要 5~30 分钟,文件平均大小越小,预热速度越快。
  • 使用 RAM 用户来执行刷新或预热操作的,需要先获得授权,请参见授予 RAM 用户刷新预热权限完成授权。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dcdn:PreloadDcdnObjectCachesWrite
  • domain
    acs:dcdn:*:{#accountId}:domain/{#domainName}

请求参数

名称类型必填描述示例值
ObjectPathstring

预热 URL,格式为加速域名/预热的文件

说明 多个 URL 之间用换行符(\n)或(\r\n)分隔,ObjectPath 的单条长度最长为 1024 个字符。
example.com/examplefile.txt
Areastring

预热区域,取值:

  • domestic:仅中国内地。
  • overseas:全球(不包含中国内地)。

如果不传该参数,默认的预热区域为您的域名所配置的 CDN 加速区域。具体如下:

  • 域名的加速区域为“仅中国内地”,预热区域是仅中国内地。
  • 域名的加速区域为“全球”,预热区域是全球。
  • 域名的加速区域为“全球(不包含中国内地)”,预热区域是全球(不包含中国内地)。
domestic
L2Preloadboolean

是否直接预热到 L2 节点。取值:

  • true:代表预热的节点层级必须包含 L2 节点。

  • false:代表仅预热回源层节点(false 为默认值,回源层节点可能是 L2 节点,也可能是 L3 节点)。

true
WithHeaderstring

支持用户自定义预热 Header,用 JSON 串格式提交。

{ "Accept-Encoding": [ "gzip" ] }

返回参数

名称类型描述示例值
object
PreloadTaskIdstring

预热返回的任务 ID,多个任务 ID 用半角逗号(,)分隔。预热返回的任务 ID 会按照以下两条规则对预热任务做合并:

  • 同一个域名、同一秒钟提交的预热任务(URL 颗粒度)会被合并为同一个 RushTaskId。
  • 同一个域名、同一秒钟提交的预热任务(URL 颗粒度)如果超过 500 条,那么会按照每 500 条合并为一个 RushTaskId 的方式处理。
95248880
RequestIdstring

请求 ID。

E5BD4B50-7A02-493A-AE0B-97B9024B4135

示例

正常返回示例

JSON格式

{
  "PreloadTaskId": "95248880",
  "RequestId": "E5BD4B50-7A02-493A-AE0B-97B9024B4135"
}

错误码

HTTP status code错误码错误信息描述
400SingleRequest.OverLimitA maximum of 1000 URLs are supported for each request.-
400QuotaExceeded.PreloadYour refresh attempts have exceeded the daily limit.超出当日刷新预热限制。
400InvalidObjectPath.MalformedThe specified ObjectPath is invalid.ObjectPath错误,请填写正确的ObjectPath。
400InvalidExtensiveDomain.ValueNotSupportedThe specified ExtensiveDomain is not supported.不支持泛域名。
400PreloadQueueFullThe warming queue is full; please try again later.域名正在预热的URL个数已经达到上限,请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400