获取多云CDN刷新和预热任务列表--多云CDN-火山引擎

文档中心

立即注册

导航

获取多云CDN刷新和预热任务列表

最近更新时间：2024.08.23 17:21:13首次发布时间：2024.03.26 21:00:55

调用本接口获取您在多云CDN创建的刷新和预热任务列表。

使用说明

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制。

使用限制

节流限制：您每秒最多可以提交 30 个 API 请求。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListContentTasks&Version=2022-03-01

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
TaskId	String	否	指定要查询的刷新或预热任务的 ID。	`660294f4e4e644f6114dea83`
TaskType	String	否	指定要查询的任务的类型。该参数有以下取值： `refresh_dir`：目录刷新 `refresh_file`：文件刷新 `preload`：文件预热	`refresh_file`
StartTime	Long	否	设置一个开始时间，格式是 Unix 时间戳。该参数与 `EndTime` 一起指定了一个时间段。本接口返回在指定时间段内创建的任务。如果您未指定时间段或者指定了无效的时间段，则接口默认返回在过去 24 小时内创建的任务。	`1711440000`
EndTime	Long	否	设置一个结束时间，格式是 Unix 时间戳。该参数与 `StartTime` 一起指定了一个时间段。本接口返回在指定时间段内创建的任务。如果您未指定时间段或者指定了无效的时间段，则接口默认返回在过去 24 小时内创建的任务。	`1711450000`
Domain	String	否	指定一个加速域名，以查询与该加速域名精确匹配的刷新和预热任务。	`www.example.com`
Url	String	否	指定一个 URL，以查询与该 URL 精确匹配的刷新和预热任务。	`http://www.example.com/home.html`
TaskStatus	String	否	指定一个任务状态，以查询处于该状态的刷新或预热任务。该参数有以下取值： `executing`：处理中 `done`：已结束	`done`
Pagination	Object	否	对查询结果进行分页并返回特定页码上的任务。如果不指定该参数，则使用该参数的默认值对结果进行分页并返回结果。

返回参数

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

请求示例

POST https://open.volcengineapi.com/?Action=ListContentTasks&Version=2022-03-01
{
    "Pagination": {
        "PageSize": 10,
        "PageNum": 1
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202403261727294E50979CC8B45D431F37",
        "Action": "ListContentTasks",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Tasks": [
            {
                "TaskId": "660294f4e4e644f6114dea83",
                "Vendor": "",
                "TaskType": "refresh_file",
                "SubTasks": [
                    {
                        "VendorTaskIds": [
                            "1799886XXXX"
                        ],
                        "Vendor": "volcengine",
                        "SubmitStatus": "success",
                        "Description": "",
                        "Url": [
                            "http://www.example.com/home.html"
                        ],
                        "CloudAccountId": "654a58632d2d5c7b10dc****",
                        "CloudAccountName": "volc-test",
                        "ProductType": "cdn",
                        "SubProduct": "cdn"
                    }
                ],
                "CreatedAt": 1711445236,
                "TaskStatus": "executing"
            }
        ],
        "Pagination": {
            "PageSize": 10,
            "PageNum": 1,
            "Total": 1
        }
    }
}

错误码

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