1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
本接口DescribeHTTPServiceCachePurgeTask为只读查询,不修改任何缓存或环境资源,仅返回指定环境下域名缓存刷新任务的状态与时间等信息。通过PurgeHTTPServiceCache清除域名缓存后,可通过此接口传入任务id可查询清除任务状态、时间、缓存类型等信息。也可通过此接口查询历史任务记录。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeHTTPServiceCachePurgeTask。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境ID 示例值:**-1gz1k5qkc06a0da4 |
| Domain | 是 | String | HTTPService域名 示例值:*.cn |
| CacheType | 否 | String | 缓存类型 枚举值:
默认值:EO 示例值:EO |
| TaskId | 否 | String | 任务id,PurgeHTTPServiceCache返回的TaskId,可选 示例值:3uie7chtuyrn |
| PurgeType | 否 | String | 按刷新类型过滤 枚举值:
示例值:PURGE_URL |
| StartTime | 否 | Timestamp ISO8601 | 查询开始时间,TaskId为空时,默认开始时间是7天前 参数格式:格式 YYYY-MM-DDTHH:mm:ss±HH:mmZ,时区为 UTC+0 示例值:2026-09-02T09:10:51Z |
| EndTime | 否 | Timestamp ISO8601 | 查询结束时间,TaskId为空时,默认结束时间是当前 参数格式:格式 YYYY-MM-DDTHH:mm:ss±HH:mmZ,时区为 UTC+0 示例值:2026-09-02T09:19:51Z |
| Offset | 否 | Integer | 分页偏移量。默认 0 示例值:0 |
| Limit | 否 | Integer | 分页限制。默认20,最大值1000 示例值:20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Tasks | Array of HTTPServiceCachePurgeTask | 任务列表 |
| TotalCount | Integer | 域名总数,分页查询使用总数判断是否已经拉取到所有数据 示例值:2 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 按时间范围查询任务列表
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHTTPServiceCachePurgeTask
<公共请求参数>
{
"EnvId": "**********-1gz1k5qkc06a0da4",
"Domain": "*********************.cn",
"StartTime": "2026-09-02T09:10:51Z",
"EndTime": "2026-09-02T09:19:51Z"
}
输出示例
{
"Response": {
"Tasks": [
{
"CacheType": "EO",
"CreateTime": "2026-09-02T09:17:51Z",
"Method": "DELETE",
"PurgeType": "PURGE_URL",
"Status": "SUCCESS",
"Targets": [
"https://*********************.cn/cloudbaseenv.json"
],
"TaskId": "3uijg0e6qmu2",
"UpdateTime": "2026-09-02T09:18:00Z"
}
],
"TotalCount": 2,
"RequestId": "94229944-e6d8-4d82-8ed2-9607e6ba4792"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ThirdServiceError | 请求第三方服务,第三方服务返回报错信息 |
| InternalError | 内部错误。 |
| InternalError.Database | 数据库错误。 |
| InternalError.Timeout | 服务超时。 |
| InvalidParameter | 参数格式或类型错误,如 Uin、EnvId、Domain 缺失或非法。 |
| InvalidParameter.EnvId | 环境ID非法。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.HTTPServiceDomain | HTTP访问服务域名不存在 |