全站加速网络刷新历史查询-内容管理相关接口-API 中心-腾讯云

1. 接口描述

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

DescribePurgeTasks 用于查询刷新任务提交历史记录及执行进度。

说明：

若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribePurgeTasks。
Version	是	String	公共参数，本接口取值：2019-10-12。
Region	否	String	公共参数，本接口不需要传递此参数。
PurgeType	否	String	查询刷新类型。url：查询 url 刷新记录；path：查询目录刷新记录。示例值：ur
StartTime	否	Timestamp	开始时间，如2018-08-08 00:00:00。
EndTime	否	Timestamp	结束时间，如2018-08-08 23:59:59。
TaskId	否	String	提交时返回的任务 Id，查询时 TaskId 和起始时间必须指定一项。示例值：1234567
Offset	否	Integer	分页查询偏移量，默认为0（从第0条开始）。示例值：0
Limit	否	Integer	分页查询限制数目，默认为20。示例值：10
Keyword	否	String	查询关键字，请输入域名或 http(s):// 开头完整 URL。
Status	否	String	查询指定任务状态，fail表示失败，done表示成功，process表示刷新中。

3. 输出参数

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

4. 示例

示例1 刷新历史查询

输入示例

https://ecdn.tencentcloudapi.com/?Action=DescribePurgeTasks
&PurgeType=ur
&TaskId=1234567
&<公共请求参数>

输出示例

{
    "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": 20
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.EcdnSystemError	系统错误，请联系腾讯云工程师进一步排查。
InvalidParameter.EcdnInterfaceError	内部接口错误，请联系腾讯云工程师进一步排查。
InvalidParameter.EcdnParamError	参数错误，请参考文档中示例参数填充。
ResourceNotFound.EcdnDomainNotExists	账号下无此域名，请确认后重试。
ResourceNotFound.EcdnUserNotExists	未开通ECDN服务，请开通后使用此接口。
UnauthorizedOperation.EcdnCamUnauthorized	子账号未配置cam策略。
UnauthorizedOperation.EcdnMigratedCdn	请前往CDN控制台进行操作。
UnauthorizedOperation.EcdnUserIsSuspended	加速服务已停服，请重启加速服务后重试。

刷新历史查询

本页目录：