1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
查询预热任务状态
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePrefetchTasks。 | 
| Version | 是 | String | 公共参数,本接口取值:2022-01-06。 | 
| Region | 否 | String | 公共参数,此参数为可选参数。 | 
| JobId | 否 | String | 任务ID | 
| StartTime | 否 | Timestamp ISO8601 | 查询起始时间 | 
| EndTime | 否 | Timestamp ISO8601 | 查询结束时间 | 
| Offset | 否 | Integer | 查询起始偏移量 | 
| Limit | 否 | Integer | 查询最大返回的结果条数 | 
| Statuses.N | 否 | Array of String | 查询的状态 允许的值为:processing、success、failed、timeout、invalid | 
| ZoneId | 否 | String | zone id | 
| Domains.N | 否 | Array of String | 查询的域名列表 | 
| Target | 否 | String | 查询的资源 | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| TotalCount | Integer | 该查询条件总共条目数 | 
| Tasks | Array of Task | 任务结果列表 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 查询预热任务
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrefetchTasks
<公共请求参数>
{
    "ZoneId": "abc",
    "StartTime": "2022-02-09T00:00:00+08:00",
    "EndTime": "2022-02-09T23:59:00+08:00",
    "Statuses": [
        "success"
    ],
    "Limit": 1,
    "Offset": 7,
    "Domains": [
        "www.qq.com"
    ]
}输出示例
{
    "Response": {
        "RequestId": "abc-afhhakf-24hkahf-2424",
        "Tasks": [
            {
                "JobId": "20g9wz8m9mgx",
                "Status": "success",
                "Target": "http://www.qq.com/a.txt",
                "Type": "prefetch_url",
                "CreateTime": "2022-02-09T02:28:43Z",
                "UpdateTime": "2022-02-09T02:28:52Z"
            }
        ],
        "TotalCount": 8
    }
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| InternalError | 内部错误。 | 
| InternalError.RouteError | 后端服务路由地址错误。 | 
| InvalidParameter.ParameterError | 参数错误: 无效 "结束时间", 不在允许的查询范围内: [开始时间, 开始+ 7天] | 
| OperationDenied | 操作被拒绝。 | 
| UnauthorizedOperation.DomainEmpty | 鉴权错误。 |