You need to enable JavaScript to run this app.
导航

提交预热任务

最近更新时间2024.02.26 16:31:42

首次发布时间2021.07.15 11:09:03

通过 API 请求提交预热任务,将指定资源从源站拉取到 CDN 节点上进行缓存。

使用限制

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

默认情况下,每个火山引擎账号下的任务额度如下:

  • 预热额度:每天最多预热 1000 个内容 URL。
  • 任务预热额度:每个任务最多预热 100 个内容 URL。

您的账号下的实际额度可能会与默认额度有差异。要看实际额度,有以下两个方法:

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

请求说明

  • 请求方式: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,内容 URL 以 http://https:// 开头。多个内容 URL 用\n\r\n分隔。
https://www.a.com/1.jpg \r\n https://www.b.com/2.jpg
Area
String

指定一个预热区域,内容分发网络将 Urls 指定的文件缓存到属于该区域的缓存节点上。该参数的默认值是加速域名的加速区域。该参数有以下取值:

  • chinese_mainland:表示预热区域是中国内地。
  • outside_chinese_mainland:表示预热区域是全球,但不包含中国内地。
  • global:表示预热区域是全球。
默认情况下,一个加速域名开通的加速区域只有 chinese_mainland。要开通其他加速区域,您需要 提交工单
ConcurrentLimit
Long
指定内容分发网络在处理预热任务时,每次向源站请求的文件数量。默认值是 10,该参数的取值范围是 1-1000。
20
RequestHeaderInstances
Object[]
表示您需要在预热请求中添加的请求头列表。列表中请求头的数量不能超过 10 个。

响应正文

参数名称
数据类型
参数说明
示例
TaskID
String
代表提交的任务 ID。您可以使用该 ID 查询任务状态。
prefetch_url_89c25a1aa3044b39921387190fc9b0e438f3d071f278f031

请求示例

POST https://cdn.volcengineapi.com/?Action=SubmitPreloadTask&Version=2021-03-01
{
  "Urls": "https://www.a.com/1.txt\nhttps://www.b.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 请求失败。更多关于错误码的信息,参见错误码