查询刷新预热任务CheckPurgePrefetchTask--全站加速-火山引擎

文档中心

立即注册

导航

查询刷新预热任务CheckPurgePrefetchTask

最近更新时间：2024.07.16 15:15:51首次发布时间：2024.07.16 15:15:51

API说明

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

请求说明

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

请求参数

Query

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

Body

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

返回参数

参数名称	数据类型	参数说明	示例
TaskList	Object[]	任务列表。	`-`
Total	Integer	符合查询条件的任务总数。	`100`

请求示例

POST https://open.volcengineapi.com?Action=CheckPurgePrefetchTask&Version=2021-04-01
{
    "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
    }