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

获取刷新和预热任务列表

最近更新时间2023.09.06 11:03:27

首次发布时间2022.07.28 21:39:27

API 说明

API 名称:ListContentTask
API 域名:open.volcengineapi.com
API 描述:获取您在多云CDN创建的刷新和预热任务列表。

请求方法

POST

使用限制

节流限制:每秒最多提交 30 个请求。

公共查询参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:

参数名称
数据类型
是否必选
参数说明
Action
String
API 的名称。该参数的取值是 ListContentTask
Version
String
API 的版本。该参数的取值是 2022-03-01

请求正文

参数名称
数据类型
是否必选
参数说明
示例
TaskId
String
表示在多云CDN创建的刷新或预热任务 ID。如果不指定该参数,则获取在 StartTime 和 EndTime 所定义的时间范围内的所有任务的 ID。
62dc99fd56139eaa6c426cbd
TaskType
String
表示任务的类型。如果不指定该参数,则查询时不对任务类型进行筛选。该参数有以下取值:
  • refresh_dir:表示目录刷新。
  • refresh_file:表示文件刷新。
  • preload:表示文件预热。
preload
StartTime
Integer
表示一个开始时间,格式是 Unix 时间戳。该 API 查询那些创建时间大于或等于该时间的任务。如果不指定 StartTime 或者 StartTime 和 EndTime 指定的时间段无效,则使用的时间段是过去的 24 小时。
1658658207
EndTime
Integer
表示一个结束时间,格式是 Unix 时间戳。该 API 查询那些创建时间小于或等于该时间的刷新或预热任务。如果不指定 EndTime 或者 StartTime 和 EndTime 指定的时间段无效,则使用的时间段是过去的 24 小时。
1658730208
Domain
String
表示任务所刷新或预热的 URL 的域名。如果不指定该参数,则查询时不对域名进行筛选。
www.example.com
Url
String
表示任务所刷新或预热的 URL。如果不指定该参数,则查询时不对 URL 进行筛选。
https://www.example.com/img
Pagination
PagingOption
表示对查询结果进行分页并返回特定页码上的任务。如果不指定该参数,则使用该参数的默认值对结果进行分页并返回结果。

响应正文

参数名称
数据类型
参数说明
示例
Tasks
TaskInfo[]
表示一个任务对象的列表。每个任务对象包含相应任务的详细信息。
Pagination
PagingResult
表示一个分页详情的对象。

示例

请求示例

POST https://open.volcengineapi.com?Version=2022-03-01&Action=ListContentTask&<其他公共请求参数>
{
    "TaskType":"refresh_dir",
    "Pagination":{
        "PageSize": 2,
        "PageNum": 1
    }
}

响应示例

{
    "ResponseMetadata": {
        "RequestID": "2022072517334201021207006908ABBD4F",
        "Action": "ListContentTask",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Tasks": [
            {
                "TaskId": "62de5f86d0df2b0fe96b4638",
                "Vendor": "",
                "TaskType": "refresh_file",
                "SubTasks": [
                    {
                        "VendorTaskIds": [
                            "refresh_url_de2fb708eafa494a95caffa1a6417d5612a434037cb6335"
                        ],
                        "Vendor": "volcengine",
                        "SubmitStatus": "success",
                        "Description": "",
                        "Url": [
                            "https://www.test.com/1.txt"
                        ],
                        "CloudAccountId": "62d4d3f424251907ba2ee2c3",
                        "ProductType": "cdn"
                    },
                    {
                        "VendorTaskIds": [
                            "14884565493"
                        ],
                        "Vendor": "aliyun",
                        "SubmitStatus": "success",
                        "Description": "",
                        "Url": [
                            "http://www.example.com/1.txt"
                        ],
                        "CloudAccountId": "629b698d6605d9f430b2b511",
                        "ProductType": "cdn"
                    }
                ],
                "CreatedAt": 1658740614
            },
            {
                "TaskId": "62de5eba56fd9eaa6c426b49",
                "Vendor": "",
                "TaskType": "preload",
                "SubTasks": [
                    {
                        "VendorTaskIds": null,
                        "Vendor": "tencent",
                        "SubmitStatus": "failed",
                        "Description": "There was an vendor error occurred. error detail:",
                        "Url": [
                            "http://www.example.com/",
                            "https://www.test.com/"
                        ],
                        "CloudAccountId": "629b6978a3997251b23a6379",
                        "ProductType": "cdn"
                    },
                    {
                        "VendorTaskIds": [
                            "c3d9adfc-6be8-4c68-bfb5-b2b36fa981de"
                        ],
                        "Vendor": "ksyun",
                        "SubmitStatus": "success",
                        "Description": "",
                        "Url": [
                            "https://www.test.com/"
                        ],
                        "CloudAccountId": "629b69d1a3997251b23a6385",
                        "ProductType": "cdn"
                    }
                ],
                "CreatedAt": 1658740410
            }
        ],
        "Pagination": {
            "PageSize": 2,
            "PageNum": 1,
            "Total": 40
        }
    }
}

错误代码

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