API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 边缘安全加速平台 EO > 内容管理相关接口 > 查询清除缓存历史记录

查询清除缓存历史记录

最近更新时间：2024-04-19 15:23:56

我的收藏

本页目录：

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

DescribePurgeTasks 用于查询提交的 URL 刷新、目录刷新记录及执行进度，通过 CreatePurgeTasks 接口提交的任务均可通过此接口进行查询。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribePurgeTasks。
Version 是 String 公共参数，本接口取值：2022-09-01。
Region 否 String 公共参数，此参数为可选参数。
ZoneId 否 String 站点ID。
必填参数。
StartTime 否 Timestamp ISO8601 查询起始时间，时间与job-id必填一个。
EndTime 否 Timestamp ISO8601 查询结束时间，时间与job-id必填一个。
Offset 否 Integer 分页查询偏移量，默认为0。
Limit 否 Integer 分页查限制数目，默认值：20，最大值：1000。
Filters.N 否 Array of AdvancedFilter 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • job-id
       按照【任务ID】进行过滤。job-id形如：1379afjk91u32h，暂不支持多值。
       类型：String
       必选：否
       模糊查询：不支持
  • target
       按照【目标资源信息】进行过滤，target形如：http://www.qq.com/1.txt或者tag1，暂不支持多值
       类型：String
       必选：否
       模糊查询：不支持
  • domains
       按照【域名】进行过滤，domains形如：www.qq.com
       类型：String
       必选：否
       模糊查询：不支持。
  • statuses
       按照【任务状态】进行过滤
       必选：否
       模糊查询：不支持。
       可选项：
       processing：处理中
       success：成功
       failed：失败
       timeout：超时
  • type
       按照【清除缓存类型】进行过滤，暂不支持多值。
       类型：String
       必选：否
       模糊查询：不支持
       可选项：
       purge_url：URL
       purge_prefix：前缀
       purge_all：全部缓存内容
       purge_host：Hostname
       purge_cache_tag：CacheTag
    		•

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 该查询条件总共条目数。
    Tasks Array of Task 任务结果列表。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询清除缓存历史记录

    通过 CreatePurgeTasks 提交刷新任务后，通过该查询接口 查询刷新任务记录及处理进度。

    输入示例

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePurgeTasks
<公共请求参数>

{
    "ZoneId": "zone-wz8m9mgx",
    "StartTime": "2022-02-09T00:00:00+08:00",
    "EndTime": "2022-02-09T23:59:00+08:00",
    "Limit": 1,
    "Offset": 7
}

    输出示例

    {
    "Response": {
        "RequestId": "abc-afhhakf-24hkahf-2424",
        "Tasks": [
            {
                "JobId": "20g9wz8m9mgx",
                "Status": "success",
                "Target": "http://www.qq.com/a.txt",
                "Type": "purge_url",
                "CreateTime": "2022-02-09T02:28:43Z",
                "UpdateTime": "2022-02-09T02:28:52Z"
            }
        ],
        "TotalCount": 8
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    InternalError 内部错误。
    InvalidParameter.ParameterError 参数错误: 无效 "结束时间", 不在允许的查询范围内: [开始时间, 开始+ 7天]
    OperationDenied 操作被拒绝。
    中国站