You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /
  • 内容分发网络

获取刷新与预热任务列表

最近更新时间：2024.01.25 20:28:20

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

我的收藏

查询过去 7 天内提交的刷新和预热任务。您可以使用多个过滤选项对任务列表进行过滤。

使用限制

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

请求说明

  • 请求方式：POST
  • 请求地址：https://cdn.volcengineapi.com/?Action=DescribeContentTasks&Version=2021-03-01

请求参数

Query

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

Body

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

指定一个或多个内容的 URL，获取对这些 URL 进行操作任务。多个内容 URL 以 \n 分隔。

如果不指定该参数，则表示任务列表不通过该参数进行过滤。
https://www.a.com/1.jpg\nhttps://www.a.com/2.jpg
DomainName
String
否

指定内容 URL 所在的加速域名。

如果不指定该参数，则表示任务列表不通过该参数进行过滤。
www.a.com
TaskID
String
否

指定一个任务的 ID。

如果不指定该参数，则表示任务列表不通过该参数进行过滤。
prefetch_url_89c25a1aa3044b39921387190fc9b0e438f3d071f278f031
TaskType
String
是

指定一个任务类型，该参数的可用值如下：

  • refresh_file：表示 URL 刷新任务。
  • refresh_dir：表示目录刷新任务。
  • preload：表示 URL 预热任务。
  • refresh_regex：表示正则刷新任务。
preload
Status
String
否

指定任务的一个状态，获取该状态下的任务列表。该参数的可用值如下：

  • complete：表示已完成的任务。
  • running：表示正在执行中的任务。
  • failed：表示执行失败的任务。
如果不指定该参数，则表示任务列表不通过该参数进行过滤。
complete
StartTime
Long
否

指定一个时间，时间格式是 Unix 时间戳，获取提交时间大于或等于该时间的任务。需要留意的是，您无法查询 7 天前提交的任务。

您必须同时指定 StartTime 和 EndTime，或者都不指定。如果您不指定这 2 个参数，默认返回过去 7 天内提交的刷新和预热任务。
1641844915
EndTime
Long
否
指定一个时间，时间格式是 Unix 时间戳。获取提交时间小于或等于该时间的任务。
1641845373
PageNum
Long
否

内容分发网络对返回的任务列表进行分页。这里您可以指定一个页码，获取属于该页面的那些任务。该参数的默认值为 1。

如果指定的页码不存在，响应正文中的 Data 参数的值为 null。您可以根据响应正文中的 Total 和 PageSize 参数的值计算页数。
1
PageSize
Long
否
指定响应正文中每页包含的任务数量。默认值是50。
10

说明

由于每个任务最多可以刷新或预热 100 个内容 URL，建议在使用一个 TaskID 查询任务时，指定 PageSize 为 100。如果不指定一个 PageSize，响应正文最多会包含 50 个内容 URL。因此某些内容 URL 可能不会包含在响应正文中。

响应正文

参数名称
数据类型
参数说明
示例
Total
Long
表示符合查询条件的任务总数。
2
PageNum
Long
表示当前页码。 该值与请求正文中的 PageNum 值相同。
1
PageSize
Long
表示每页的任务数量。
100
Data
Object[]
表示符合查询条件的任务的集合。如果不存在符合查询条件的任务，该参数值为 null。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeContentTasks&Version=2021-03-01
{
  "StartTime": 1625587200,
  "EndTime": 1625673600,
  "TaskType": "preload",
  "PageSize": 10,
  "PageNum": 1
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202107071614380102040541590202DB57",
    "Action": "DescribeContentTasks",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  },
  "Result": {
    "Data": [
      {
        "Url": "http://www.example.com/1.txt",
        "Status": "complete",
        "TaskType": "preload",
        "CreateTime": 1625643834,
        "TaskID": "prefetch_url_89c25a1aa3044b39921387190fc9b0e438f3d071f278f031",
        "Process": "100%"
      },
      {
        "Url": "http://www.example.com/2.txt",
        "Status": "failed",
        "TaskType": "preload",
        "CreateTime": 1625643834,
        "TaskID": "prefetch_url_89c25a1aa3044b39921387190fc9b0e438f3d071f278f031",
        "Process": "100%"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "Total": 2
  }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。