You need to enable JavaScript to run this app.
导航
全站加速
  • 文档首页
    • /
  • 全站加速

创建刷新预热任务

最近更新时间：2023.10.26 11:48:58

首次发布时间：2022.03.02 11:29:34

我的收藏

API说明

API名称：CreatePurgePrefetchTask 。
API域名：open.volcengineapi.com。
API描述：新增全站加速预热刷新任务。

URI参数

公共参数

Action和Version需要放在请求 URL 后方参数中。

参数名称
是否必选
参数类型
参数说明
Action
是
String
API 名称，该参数的取值是 CreatePurgePrefetchTask 。
Version
是
String
API 版本，该参数的取值是 2021-04-01 。

请求正文

参数名称
是否必选
参数类型
参数说明
示例值
TaskType是String任务类型，支持参数：
refresh_url：URL 刷新。
refresh_dir： 目录刷新。
prefetch_url： URL 预热。		refresh_url
Urls是[ ]String待刷新/预热的URL/目录，目录以/结尾。单次提交数组长度上限：
URL刷新：1000 。
目录刷新：20 。
URL预热：100 。		["http://www.test.com/index"]

响应正文

参数名称
参数类型
参数说明
示例值
TaskIdString任务id。1001
TaskStatusString任务状态，支持参数：
running：执行中。
fail： 失败。
succeed： 成功。		succeed
TaskQuotaRemainInteger当前任务类型的当日额度剩余。举例：请求参数中指定TaskType为refresh_url，返回参数中TaskQuotaRemain为100，则说明当日还能提交100个待刷新的url。100

调用示例

请求示例

POST https://open.volcengineapi.com/?Version=2021-04-01&Action=CreatePurgePrefetchTask&<其他公共请求参数>
{
    "TaskType": "refresh_url",
    "Urls": [ 
        "https://www.test.com/index"
    ]
}

响应示例

{
   "ResponseMetadata": {
       "RequestId": "202107191522410102252431530006E032",
       "Action": "CreatePurgePrefetchTask",
       "Version": "2021-04-01",
       "Service": "dcdn",
       "Region": "cn-south-1"
    },
   "Result":  {
        "TaskId": "1001",
        "TaskStatus": "running", 
        "TaskQuotaRemain": 50
    }