获取刷新与预热任务列表--内容分发网络-火山引擎

文档中心

立即注册

导航

获取刷新与预热任务列表

最近更新时间：2024.09.11 15:45:28首次发布时间：2021.07.15 11:09:03

获取过去 7 天内提交的刷新或预热任务，细分到这些任务中的每个 URL。返回结果展示了每个 URL 任务的详情，包括任务的执行结果。您可以使用多个过滤选项对 URL 任务列表进行过滤。

使用限制

节流限制：您每秒最多可以发送 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.example.com/1.jpg\nhttps://www.example.com/2.jpg`
DomainName	String	否	表示一个加速域名。对于包含该加速域名的 URL，获取这些 URL 的任务。如果不指定该参数，则表示不使用该参数对任务列表进行过滤。	`www.example.com`
TaskID	String	否	表示一个任务 ID，用以获取该 ID 的所有 URL 任务。如果不指定该参数，则表示不使用该参数对任务列表进行过滤。	`prefetch_url_89c25a1aa3044b39921387190fc9b0e438f3d071f278f031`
TaskType	String	是	表示一个任务类型，以获取该类型的所有 URL 任务。该参数的可用值如下： `refresh_file`：表示 URL 刷新任务。 `refresh_dir`：表示目录刷新任务。 `preload`：表示 URL 预热任务。 `refresh_regex`：表示正则刷新任务。	`preload`
Status	String	否	表示一个任务状态，以获取该状态下的所有 URL 任务。该参数的可用值如下： `complete`：表示已完成的任务。 `running`：表示执行中的任务。 `failed`：表示执行失败的任务。如果不指定该参数，则表示不使用该参数对任务列表进行过滤。	`complete`
StartTime	Long	否	表示一个开始时间，格式是 Unix 时间戳，以获取提交时间晚于或等于该时间的 URL 任务。需要留意的是，您无法查询 7 天前提交的 URL 任务。您必须同时指定 `StartTime` 和 `EndTime`，或者两个参数都不指定。如果两个参数都不指定，则获取过去 7 天内提交的 URL 任务。	`1641844915`
EndTime	Long	否	表示一个结束时间，格式是 Unix 时间戳，以获取提交时间早于或等于该时间的 URL 任务。	`1641845373`
PageNum	Long	否	表示一个页码，用以获取该页面上的 URL 任务。该参数的默认值为 `1`。 CDN 对符合过滤条件的 URL 任务进行分页。您可以根据响应正文中的 `Total` 和 `PageSize` 参数的值计算页数。	`1`
PageSize	Long	否	表示每页包含的 URL 任务数量。该参数的取值范围是 1-1000，默认值是 `50`。	`10`

响应正文

参数名称	数据类型	参数说明	示例
Total	Long	表示符合过滤条件的 URL 任务总数。	`2`
PageNum	Long	表示请求正文中的 `PageNum`。	`1`
PageSize	Long	表示请求正文中的 `PageSize`。	`100`
Data	Object[]	表示 `PageNum` 上的 URL 任务列表。如果 `PageNum` 所表示页码不存在或者该页上没有任务，该参数值为 `null`。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406301943207719B7467E55D873075E",
        "Action": "DescribeContentTasks",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "Data": [
            {
                "CreateTime": 1719747333,
                "Process": "100%",
                "Remark": "",
                "Status": "complete",
                "TaskID": "prefetch_url_1f331b26ccea4295ba1c998905fbbeaa2be710cc6092caf9",
                "TaskType": "preload",
                "Url": "http://www.example.com/file/2023-10-30/22b91021.txt"
            },
            {
                "CreateTime": 1719746130,
                "Process": "100%",
                "Remark": "",
                "Status": "complete",
                "TaskID": "prefetch_url_bf174efdb3d746d08d47940063ee81c7d82a396040acbf5",
                "TaskType": "preload",
                "Url": "http://www.example.com/file/2023-10-30/cd09eb1a.txt"
            },
            {
                "CreateTime": 1719746010,
                "Process": "100%",
                "Remark": "",
                "Status": "complete",
                "TaskID": "prefetch_url_e6477a35fe89408283a92dc6cd2bda402d2aa2f0b5a8602b",
                "TaskType": "preload",
                "Url": "http://abc.example.com/file/2024-06-30/zQMAvCmInJHUsqNiRkXPODdjWZLuBaGS.txt"
            },
            {
                "CreateTime": 1719745572,
                "Process": "100%",
                "Remark": "origin_error",
                "Status": "failed",
                "TaskID": "prefetch_url_6780a46449664086bbe41c5bca3b132a11897aa11310a35b",
                "TaskType": "preload",
                "Url": "http://www.example.com/WhMnkrdHUVBoZJRgtqGDXyjTOFLxCIae"
            },
            {
                "CreateTime": 1719745572,
                "Process": "100%",
                "Remark": "origin_error",
                "Status": "failed",
                "TaskID": "prefetch_url_6780a46449664086bbe41c5bca3b132a11897aa11310a35b",
                "TaskType": "preload",
                "Url": "http://www.example.com/kIAuCRNXMFmpUonbrgcjeitsfLBhyOvV"
            }
        ],
        "PageNum": 1,
        "PageSize": 5,
        "Total": 610
    }
}

错误码

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