You need to enable JavaScript to run this app.
文档中心
文档备案控制台
全站加速

全站加速

请输入
  • 文档首页
    • 全站加速开发指南API参考刷新预热接口创建刷新预热任务 CreatePurgePrefetchTask
复制全文
我的收藏
刷新预热接口
创建刷新预热任务 CreatePurgePrefetchTask
复制全文
我的收藏
创建刷新预热任务 CreatePurgePrefetchTask

创建刷新预热任务。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=CreatePurgePrefetchTask&Version=2021-04-01

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
TaskType
String
是

任务类型。支持取值：

  • refresh_url：URL 刷新；
  • refresh_dir：目录刷新；
  • prefetch_url：URL 预热。
refresh_url
Urls
String[]
是

待刷新或预热的 URL 或目录列表，目录需以 / 结尾。单次提交的数组长度上限如下。

  • refresh_url：1000
  • refresh_dir：20
  • prefetch_url：100
["http://www.example.com/index.html","http://www.example.com/about.html"]
Region
String
否

标识预热请求的区域，仅对 prefetch_url 类型的任务生效。支持取值：

  • follow（默认）：遵循加速区域；
  • domestic：中国大陆；
  • overseas：全球（除中国大陆）；
  • global：全球。
domestic

返回参数

参数名称
数据类型
参数说明
示例
TaskId
String
创建刷新预热任务后返回的任务 ID，用于后续查询任务状态或重试任务。
1001
TaskStatus
String

刷新预热任务的执行状态。支持取值：

  • running：执行中；
  • fail：失败；
  • succeed：成功。
succeed
TaskQuotaRemain
Integer
当前任务类型的当日剩余额度。例如，当 TaskType 为 refresh_url 时，该字段表示当日还能提交的待刷新 URL 数量。
100

请求示例 

POST https://open.volcengineapi.com?Action=CreatePurgePrefetchTask&Version=2021-04-01
{
    "TaskType": "prefetch_url",
    "Urls": [
        "http://www.example.com/image1.jpg",
        "http://www.example.com/image2.jpg"
    ],
    "Region": "global"
}

返回示例 

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreatePurgePrefetchTask",
        "Version": "2021-04-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "1001",
        "TaskStatus": "running",
        "TaskQuotaRemain": 90
    }
}
最近更新时间：2026.02.24 16:35:11
这个页面对您有帮助吗？
有用
有用
无用
无用