刷新目录

1. 接口描述

此接口处于预下线状态 。

预计下线时间：2023-07-25 18:59:40

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

ECDN融合CDN后，接口都用CDN的，此接口已经废弃

PurgePathCache 用于批量刷新目录缓存，一次提交将返回一个刷新任务id。

说明：

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

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：PurgePathCache。
Version	是	String	公共参数，本接口取值：2019-10-12。
Region	否	String	公共参数，本接口不需要传递此参数。
Paths.N	是	Array of String	要刷新的目录列表，必须包含协议头部。 示例值：["http://www.test.com\/test\/"]
FlushType	是	String	刷新类型，flush 代表刷新有更新的资源，delete 表示刷新全部资源。 示例值：flush

3. 输出参数

参数名称	类型	描述
TaskId	String	刷新任务Id。 示例值：1533045796-i60rfmzm
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 刷新Url目录

输入示例

https://ecdn.tencentcloudapi.com/?Action=PurgePathCache
&Paths.0=http://www.test.com/test/
&FlushType=flush
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "4d5a83f8-a61f-445b-8036-5636be640bef",
        "TaskId": "1533045796-i60rfmzm"
    }
}

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. 错误码

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

错误码	描述
FailedOperation.EcdnConfigError	域名配置更新操作失败，请重试或联系客服人员解决。
InternalError.EcdnDbError	内部数据错误，请联系腾讯云工程师进一步排查。
InternalError.EcdnSystemError	系统错误，请联系腾讯云工程师进一步排查。
InvalidParameter.EcdnDomainInvalidStatus	域名状态不合法。
InvalidParameter.EcdnInterfaceError	内部接口错误，请联系腾讯云工程师进一步排查。
InvalidParameter.EcdnParamError	参数错误，请参考文档中示例参数填充。
InvalidParameter.EcdnPurgeWildcardNotAllowed	刷新不支持泛域名。
InvalidParameter.EcdnUrlExceedLength	URL 超过限制长度。
LimitExceeded.EcdnPurgePathExceedBatchLimit	刷新的目录数量超过单次限制。
LimitExceeded.EcdnPurgePathExceedDayLimit	刷新的目录数量超过每日限制。
ResourceNotFound.EcdnDomainNotExists	账号下无此域名，请确认后重试。
ResourceNotFound.EcdnUserNotExists	未开通ECDN服务，请开通后使用此接口。
UnauthorizedOperation.EcdnCamUnauthorized	子账号未配置cam策略。
UnauthorizedOperation.EcdnDomainUnauthorized	ECDN子账号加速域名未授权。
UnauthorizedOperation.EcdnMigratedCdn	请前往CDN控制台进行操作 。
UnauthorizedOperation.EcdnUserIsSuspended	加速服务已停服，请重启加速服务后重试。
UnauthorizedOperation.OperationTooOften	操作过于频繁，请稍后重试 。