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

查询刷新预热任务

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

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

API说明

API名称:CheckPurgePrefetchTask 。
API域名:open.volcengineapi.com。
API描述:查询全站加速预热刷新任务。

URI参数

公共参数

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

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

请求正文

参数名称
是否必选
参数类型
参数说明
示例值
TaskType[ ]String任务类型,支持参数:
refresh_url:URL 刷新。
refresh_dir: 目录刷新。
prefetch_url: URL 预热。
["refresh_url"]
TaskStatus[ ]String任务状态,支持参数:
running:执行中。
fail: 失败。
succeed: 成功。
["succeed","running"]
UrlString任务中包含的url,支持模糊查询。http://www.test.com/index
StartTimeString起始时间,不超过30天前。2021-10-29 15:04:05
EndTimeString终止时间,起止时间不能超过三天。2021-10-29 18:04:05
PageInteger页码,不填默认为1 。1
PageSizeInteger页大小,不填默认为20,最大支持500 。20
OrderTypeString查询结果排序方式,不填默认按时间降序,支持参数:
OpTime_DESC:按时间降序。
OpTime_ASC: 按时间升序。
OpTime_ASC

响应正文

参数名称
参数类型
参数说明
示例
TaskList
Task
任务列表。
-
Total
Integer
符合查询条件的任务总数。
1000

调用示例

请求示例

POST https://open.volcengineapi.com/?Version=2021-04-01&Action=CheckPurgePrefetchTask&<其他公共请求参数>
{
    "TaskType": ["refresh_url"],
    "TaskStatus": ["running"], 
    "Url": "https://www.toutiao.com/index",
    "StartTime": "2021-10-29 15:04:05", 
    "EndTime": "2021-10-29 18:04:05", 
    "Page": 1, 
    "PageSize": 100, 
    "OrderType": "OpTime_DESC"
}

响应示例

{
   "ResponseMetadata": {
       "RequestId": "202107191522410102252431530006E032",
       "Action": "CreatePurgePrefetchTask",
       "Version": "2021-04-01",
       "Service": "dcdn",
       "Region": "cn-south-1"
    },
   "Result":{
       "TaskList":[ 
          {
            "TaskID": "1001",
            "TaskType": "refresh_url",
            "Urls": ["https://www.toutiao.com/index"],
            "TaskStatus": "running", 
            "Retries": 2,
            "OpTime": "2021-10-29 15:04:05",
            "Account": "110022", 
            "Operator": "110022"
         }
        ]
      "Total": 100
    }