You need to enable JavaScript to run this app.
导航
(已废弃)获取刷新和预热任务列表
最近更新时间:2024.03.26 21:00:55首次发布时间:2022.07.28 21:39:27

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

注意

本接口已经废弃,虽然现在仍可调用,但可能不再接受更新或者支持,因此我们不建议您使用本接口。您可以使用 ListContentTasks 接口作为本接口的替代。

使用说明

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

使用限制

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

请求说明

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

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
TaskId
String
指定要查询的刷新或预热任务的 ID。
62dc99fd56139eaa6c426cbd
TaskType
String

指定要查询的任务的类型。该参数有以下取值:

  • refresh_dir:目录刷新
  • refresh_file:文件刷新
  • preload:文件预热
preload
StartTime
Long

设置一个开始时间,格式是 Unix 时间戳。该参数与 EndTime 一起指定了一个时间段。本接口返回在指定时间段内创建的任务。

如果您未指定时间段或者指定了无效的时间段,则接口默认返回在过去 24 小时内创建的任务。
1658658207
EndTime
Long

设置一个结束时间,格式是 Unix 时间戳。该参数与 StartTime 一起指定了一个时间段。本接口返回在指定时间段内创建的任务。

如果您未指定时间段或者指定了无效的时间段,则接口默认返回在过去 24 小时内创建的任务。
1658730208
Domain
String
指定一个加速域名,以查询与该加速域名精确匹配的刷新和预热任务。
www.example.com
Url
String
指定一个 URL,以查询与该 URL 精确匹配的刷新和预热任务。
https://www.example.com/img.jpg
Pagination
Object
对查询结果进行分页并返回特定页码上的任务。如果不指定该参数,则使用该参数的默认值对结果进行分页并返回结果。
TaskStatus
String

指定一个任务状态,查询处于指定状态的任务。该参数有以下取值:

  • executing:处理中
  • done:已结束

响应正文

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

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestID": "20240219203648DAF5D97481B3BEAA59AC",
        "Action": "ListContentTask",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Tasks": [
            {
                "TaskId": "65d2c9b64fb1452d12d4df91",
                "Vendor": "",
                "TaskType": "refresh_file",
                "SubTasks": [
                    {
                        "VendorTaskIds": [
                            "17803183907"
                        ],
                        "Vendor": "aliyun",
                        "SubmitStatus": "success",
                        "Description": "",
                        "Url": [
                            "http://www.example.com/home.html"
                        ],
                        "CloudAccountId": "654a58632d2d5c7b10dc2b05",
                        "CloudAccountName": "aliyun",
                        "ProductType": "cdn",
                        "SubProduct": "cdn"
                    }
                ],
                "CreatedAt": 1708313014,
                "TaskStatus": "done",
                "EndAt": 1708313194
            }
        ],
        "Pagination": {
            "PageSize": 10,
            "PageNum": 1,
            "Total": 1
        }
    }
}

错误码

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