You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/点播 CDN/刷新预热/获取刷新预热任务列表
获取刷新预热任务列表
最近更新时间：2024.06.25 12:54:27首次发布时间：2022.04.13 21:18:00
我的收藏

此接口用于在指定空间下获取刷新预热任务列表。

请求说明

请求地址：https://vod.volcengineapi.com?Action=ListCdnTasks&Version=2022-01-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数
类型
是否必选
示例值
描述
Action
String
是
ListCdnTasks
接口名称。当前 API 的名称为 ListCdnTasks。
Version
String
是
2022-01-01
接口版本。当前 API 的版本为 2022-01-01。
SpaceName
String
是
test

点播空间名称。您可通过以下方式获取：

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
TaskId
String
否
6242b6d******4e9451a3cff
任务 ID。仅支持单个 ID 查询。
DomainName
String
否
example.vod.com
域名。仅支持单个查询。
TaskType
String
否
refresh_file

任务类型。取值如下：

  • refresh_file：URL 刷新。
  • refresh_dir：目录刷新。
  • preload：URL 预热。
Status
String
否
complete

任务状态。多个用英文逗号 , 隔开。取值如下：

  • complete：执行成功。
  • running：执行中。
  • failed：执行失败。
StartTimestamp
Integer
否
1703433600

开始时间。相对于 UTC 1970-01-01 到当前时间相隔的秒数。不传默认当天 00:00:00。

说明

仅能查询近 7 天数据。

EndTimestamp
Integer
否
1703519999
结束时间。相对于 UTC 1970-01-01 到当前时间相隔的秒数。不传默认当天 23:59:59。
PageNum
Integer
否
1
页码。默认为 1。范围为大于等于 1。
PageSize
Integer
否
10
页面大小。每页显示的条目数。默认为 10。取值范围为不大于 50。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数
类型
示例值
描述
TotalCount
Integer
1
记录总数。
PageNum
Integer
1
页码。
PageSize
Integer
1
页面大小。
ContentInfos
Object[]
-
任务记录列表。
ItemId
String
ItemId
记录 ID。可为空。
Url
String
Url
任务 URL。
Status
String
complete

任务状态。取值如下：

  • complete：执行成功。
  • running：执行中。
  • failed：执行失败。
TaskType
String
refresh_file

任务类型。取值如下：

  • refresh_file：URL 刷新。
  • refresh_dir：目录刷新。
  • preload：URL 预热。
CreateTimestamp
Integer
1
任务创建时间。单位为 Unix 秒级时间戳。
TaskId
String
TaskId
任务 ID。
Message
String
任务信息

请求示例

https://vod.volcengineapi.com?Action=ListCdnTasks&Version=2022-01-01&SpaceName=test&TaskId=6242b6d******4e9451a3cff&DomainName=example.vod.com&TaskType=refresh_file&Status=complete&StartTimestamp=1635243457&EndTimestamp=1635243480&PageNum=1&PageSize=10

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20201124165******25107034080031B5",
    "Action": "ListCdnTasks",
    "Version": "2022-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "TotalCount": 1,
    "PageNum": 1,
    "PageSize": 1,
    "ContentInfos": [
      {
        "ItemId": "ItemId",
        "Url": "Url",
        "Status": "Status",
        "TaskType": "TaskType",
        "CreateTimestamp": 1,
        "TaskId": "TaskId"
      }
    ]
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码错误码错误信息说明
400InvalidParameter.InvalidSpaceName-无效的 SpaceName

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：