创建清除缓存任务

1. 接口描述

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

当源站资源更新，但节点缓存 TTL 未过期时，用户仍会访问到旧的资源，此时可以通过该接口实现节点资源更新。触发更新的方法有以下两种：

清除缓存任务详情请查看清除缓存。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 URL刷新

此清除类型使用的是直接删除的清除方法，会匹配清除提交的 URL 的节点缓存资源。
例如：需要清除站点域名 www.example.com 下 /a.txt 资源，可以参照以下示例进行刷新。

输入示例

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

{
    "Targets": [
        "http://www.example.com/a.txt"
    ],
    "Type": "purge_url",
    "ZoneId": "zone-ajj243dwrew"
}

输出示例

{
    "Response": {
        "JobId": "20ga521cpwch",
        "FailedList": [],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

示例2 Hostname 刷新

此清除类型使用的是标记过期的清除方法，会将提交的 Hostname 下的所有资源标记为过期。
例如：需要清除站点域名 www.example.com 下所有发生过变更的资源，可以参照以下示例进行刷新。

输入示例

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

{
    "Targets": [
        "www.example.com"
    ],
    "Type": "purge_host",
    "ZoneId": "zone-ajj243dwrew"
}

输出示例

{
    "Response": {
        "JobId": "20ga521cpwcs",
        "FailedList": [],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

示例3 Cache-Tag 刷新

此清除类型使用的是直接清除的清除方法，会将该站点下所有 HTTP 应答包中存在对应 Cache-Tag 响应头标签值（tags）的资源直接清除。
例如：需要清除站点 example.com 下所有 HTTP 应答包中包含 tag1、tag2 或 tag3 标签的资源，可以参照以下示例进行刷新。

输入示例

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

{
    "Targets": [
        "tag1",
        "tag2",
        "tag3"
    ],
    "Type": "purge_cache_tag",
    "ZoneId": "zone-ajj243dwrew"
}

输出示例

{
    "Response": {
        "JobId": "20ga521cpwcs",
        "FailedList": [],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

示例4 刷新站点下全部缓存

此清除类型使用的是标记过期的清除方法，会将所提交站点下的缓存内容都标记为过期。
例如：需要清除站点 example.com 下的所有发生过变更的资源，可以参考以下示例进行刷新。

输入示例

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

{
    "Type": "purge_all",
    "ZoneId": "zone-ajj243dwrew"
}

输出示例

{
    "Response": {
        "JobId": "20ga521cpwcs",
        "FailedList": [],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

示例5 目录刷新 — 直接删除对应目录下的资源

此清除方式需要将 Method 的值调整为 delete， 使用直接删除的清除方法清除节点资源。
例如：需要清除站点域名 www.example.com 下 /test 目录下所有资源，可以参考以下示例进行刷新。

输入示例

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

{
    "Targets": [
        "http://www.example.com/test/"
    ],
    "Type": "purge_prefix",
    "Method": "delete",
    "ZoneId": "zone-ajj243dwrew"
}

输出示例

{
    "Response": {
        "JobId": "20ga521cpwck",
        "FailedList": [],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

示例6 目录刷新 — 仅刷新目录下发生变更的资源

此清除类型默认使用的是标记过期的清除方法，可以根据 Method 调整清除方式。
例如：需要清除站点域名 www.example.com 下 /test 目录下所有发生变更的资源，可以参考以下示例进行刷新。

输入示例

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

{
    "Targets": [
        "http://www.example.com/test/"
    ],
    "Type": "purge_prefix",
    "Method": "invalidate",
    "ZoneId": "zone-ajj243dwrew"
}

输出示例

{
    "Response": {
        "JobId": "20ga521cpwcj",
        "FailedList": [],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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

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