内容分发网络 CDN 刷新历史查询

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribePurgeTasks。
Version	是	String	公共参数，本接口取值：2018-06-06。
Region	否	String	公共参数，本接口不需要传递此参数。
PurgeType	否	String	指定刷新类型查询 url：url 刷新记录 path：目录刷新记录示例值：url
StartTime	否	Timestamp	根据时间区间查询时，填充开始时间，如 2018-08-08 00:00:00 示例值：2021-02-01 00:00:00
EndTime	否	Timestamp	根据时间区间查询时，填充结束时间，如 2018-08-08 23:59:59 示例值：2021-02-01 01:00:00
TaskId	否	String	根据任务 ID 查询时，填充任务 ID 查询时任务 ID 与起始时间必须填充一项示例值：123abc
Offset	否	Integer	分页查询偏移量，默认为 0 示例值：0
Limit	否	Integer	分页查询限制数目，默认为 20 示例值：10
Keyword	否	String	支持域名过滤，或 http(s):// 开头完整 URL 过滤示例值： http(s)://abc.com/index.html
Status	否	String	指定任务状态查询 fail：刷新失败 done：刷新成功 process：刷新中示例值：process
Area	否	String	指定刷新地域查询 mainland：境内 overseas：境外 global：全球示例值：mainland

3. 输出参数

参数名称	类型	描述
PurgeLogs	Array of PurgeTask	详细刷新纪录
TotalCount	Integer	任务总数，用于分页示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 刷新历史查询

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribePurgeTasks
&TaskId=1234567
&Area=mainland
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "4d5a83f8-a61f-445b-8036-5636be640bef",
        "PurgeLogs": [
            {
                "TaskId": "153303185323131331",
                "Url": "http://www.test.com/",
                "Status": "done",
                "PurgeType": "url",
                "FlushType": "flush",
                "CreateTime": "2018-07-30 18:10:53"
            }
        ],
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.CamSystemError	内部鉴权系统错误。
InternalError.CdnDbError	内部数据错误，请联系腾讯云工程师进一步排查。
InternalError.CdnQuerySystemError	内部查询错误，请重试或联系客服人员解决。
InternalError.CdnSystemError	系统错误，请联系腾讯云工程师进一步排查。
InternalError.Error	内部服务错误，请联系腾讯云工程师进一步排查。
InternalError.ProxyServer	内部服务错误，请联系腾讯云工程师进一步排查。
InternalError.RouteError	内部服务错误，请联系腾讯云工程师进一步排查。
InternalError.UnknownError	内部服务错误，请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError	参数错误，请参考文档中示例参数填充。
ResourceNotFound.CdnUserNotExists	未开通CDN服务，请开通后使用此接口。
UnauthorizedOperation.CdnCamUnauthorized	子账号未配置cam策略。
UnauthorizedOperation.OpNoAuth	暂不支持此操作，请联系腾讯云工程师处理。
UnauthorizedOperation.OperationTooOften	操作超出调用频次限制。

刷新历史查询

本页目录：