提交预热任务--内容分发网络-火山引擎

文档中心

立即注册

导航

提交预热任务

最近更新时间：2024.07.03 17:46:12首次发布时间：2021.07.15 11:09:03

在火山引擎内容分发网络（CDN）中提交一个预热任务，将一个或者多个文件提前缓存到 CDN 的缓存节点。

使用限制

节流限制：您每秒最多可以发送 20 个请求。

默认情况下，每个火山引擎主账号的任务额度如下：

每天最多预热 1,000 个 URL。
每个任务最多预热 100 个 URL。

实际额度可能会与默认额度有差异。要看实际额度，有以下两个方法：

打开火山引擎控制台的刷新预热页面。
调用 DescribeContentQuota。

如需调整任务额度，请联系火山引擎服务技术支持。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=SubmitPreloadTask&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `SubmitPreloadTask`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Urls	String	是	表示一个或多个文件 URL。CDN 将这些文件提前缓存到缓存节点。每个 URL 都必须以 `http://` 或 `https://` 开头。多个 URL 之间使用 `\n` 分隔。说明 URL 中不能包含泛域名。如果您需要为一个泛域名下的多个子域名提交一个预热任务，您必须对每个子域名指定需要预热的那些 URL。参见如何对泛域名下的文件和目录执行刷新、预热、封禁和解封操作。	`https://www.example.com/1.jpg\nhttps://www.example.com/2.jpg`
Area	String	否	表示一个加速区域。CDN 将 `Urls` 中的每个文件提前缓存到该区域下的那些缓存节点。该参数有以下取值： `chinese_mainland`：表示中国内地。 `outside_chinese_mainland`：表示全球，但不包含中国内地。 `global`：表示全球。如果不指定该参数，对于 `Urls` 中一个 URL，这个加速区域就是该 URL 所含域名的加速区域。	`chinese_mainland`
ConcurrentLimit	Long	否	表示 CDN 在执行预热任务时，每次向源站请求的最大文件数量。默认值是 `10`，该参数的取值范围是 1-1000。	`20`
RequestHeaderInstances	Object[]	否	表示 CDN 在执行预热任务时所发送的回源请求中需要额外包含的请求头列表。列表中请求头的数量不能超过 10 个。

响应正文

参数名称	数据类型	参数说明	示例
TaskID	String	表示该任务的 ID。您可以调用 DescribeContentTasks 查看 `Urls` 中每个 URL 的预热结果。	`prefetch_url_89c25a1aa3044b39921387190fc9b0e438f3d071f278f031`

请求示例

POST https://cdn.volcengineapi.com/?Action=SubmitPreloadTask&Version=2021-03-01
{
  "Urls": "https://www.example.com/1.txt\nhttps://www.example.com/2.txt"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202107071543530102121532120B018FF5",
    "Action": "SubmitPreloadTask",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "TaskID": "prefetch_url_89c25a1aa3044b39921387190fc9b0e438f3d071f278f031"
  }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。