帮你快速理解、总结文档立即下载
文档中心>API 中心>云开发 CloudBase>云开发接入相关接口>清除HTTP服务域名缓存

清除HTTP服务域名缓存

最近更新时间：2026-09-09 02:54:01
我的收藏

本页目录：

1. 接口描述

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

本接口PurgeHTTPServiceCache为异步操作，清除指定环境下 HTTPService 域名的缓存，操作不可逆，仅影响指定 Domain 的缓存命中，不影响源站数据。用于清除HTTP访问服务域名缓存。支持刷新CDN和EO两种类型。清除缓存后会生成任务id，通过DescribeHTTPServiceCachePurgeTask传入任务id可查询任务进度和详细信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：PurgeHTTPServiceCache。
Version 是 String 公共参数，本接口取值：2018-06-08。
Region 否 String 公共参数，本接口不需要传递此参数。
EnvId 是 String

环境ID


示例值：**-1gz1k5qkc06a0da4
Domain 是 String

HTTPService域名


示例值：*.cn
Targets.N 是 Array of String

Targets

参数格式：Targets 刷新目标列表，语义随 PurgeType 变化

入参限制：单次请求最多传 20 个 Target，单条 URL/prefix/host 最长 2048


示例值：["https://*.cn/cloudbaseenv.json"]
CacheType 否 String

需要刷新的缓存类型：CDN 或 EO

枚举值：

  • EO： EO缓存
  • CDN： CDN缓存

默认值：EO


示例值：EO
PurgeType 否 String

PurgeType 刷新方式（purge 粒度），TCBCDN仅支持purge_url

枚举值：

  • PURGE_URL： URL 列表（需含协议，如 https://a.com/b.jpg）
  • PURGE_PREFIX： URL 前缀列表（需含协议，如 https://a.com/dir/），仅EO支持
  • PURGE_HOST： Hostname 列表（可为 host 或 http(s)://host），仅EO支持

默认值：PURGE_URL


示例值：PURGE_URL

3. 输出参数

参数名称 类型 描述
CacheType String

需要刷新的缓存类型：TCBCDN 或 EO

枚举值：

  • EO： EO缓存
  • CDN： CDN缓存

示例值：EO
TaskId String

刷新任务ID


示例值：3uk1onlg81ab
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 清除EO缓存

输入示例

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

{
    "EnvId": "**********-1gz1k5qkc06a0da4",
    "Domain": "*********************.cn",
    "Targets": [
        "https://*********************.cn/cloudbaseenv.json"
    ],
    "PurgeType": "PURGE_URL",
    "CacheType": "EO"
}

输出示例

{
    "Response": {
        "CacheType": "EO",
        "TaskId": "3uk1onlg81ab",
        "RequestId": "f6f50b8b-6ada-42cb-9ae4-fa35d37c5cf0"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数格式或类型错误，如 Uin、EnvId、Domain 缺失或非法。
InvalidParameter.EnvId 环境ID非法。
ResourceNotFound 资源不存在。
ResourceNotFound.HTTPServiceDomain HTTP访问服务域名不存在
中国站