Domain name for API request: teo.intl.tencentcloudapi.com.
DescribePrefetchTasks is used to query the submission history and execution progress of preheating tasks. This interface can be used to query the tasks submitted by the CreatePrefetchTasks interface.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribePrefetchTasks. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | No | String | Site ID. this parameter will change from selectable to required after may 30, 2024. for details, see the announcement: tencent cloud EdgeOne: tencentcloud API change notification. |
| StartTime | No | Timestamp ISO8601 | Start time of the query. Either time or job-id is required. |
| EndTime | No | Timestamp ISO8601 | End time of the query. Either time or job-id is required. |
| Offset | No | Integer | Offset of paginated query. Default value: 0. |
| Limit | No | Integer | Number limit of paginated query. Default value: 20. Maximum value: 1000. |
| Filters.N | No | Array of AdvancedFilter | Filter criteria. the maximum number of Filters.Values is 20. the detailed filter criteria are as follows: processing: processing success: successful failed: failed timeout: timed out canceled: canceled invalid: invalid, that is, the origin server response status code is not 2xx. please check the origin server service. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of items in the query condition. |
| Tasks | Array of Task | Task result list. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query task records and execution progress using the API after submitting a preheat task via CreatePrefetchTasks.
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrefetchTasks
<Common request parameters>
{
"ZoneId": "zone-z8m9mgx",
"StartTime": "2022-02-09T00:00:00+08:00",
"EndTime": "2022-02-09T23:59:00+08:00",
"Limit": 2,
"Offset": 0
}
{
"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"
},
{
"JobId": "3duxkechrr0c",
"Status": "failed",
"Target": "http://www.qq.com/b.txt",
"Type": "prefetch_url",
"FailType": "originPullFailed",
"FailMessage": "Origin-pull failure, retry or check if the origin server exists, service unavailable or response timeout, throttling policy triggered, security policy restricted, network failure, bandwidth/connection limit."
"CreateTime": "2022-02-09T02:28:43Z",
"UpdateTime": "2022-02-09T02:28:52Z"
}
],
"TotalCount": 2
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter.ParameterError | Parameter error: Invalid “End time”. The interval between the start and end time cannot exceed 7 days. |
| OperationDenied | Operation denied. |
| UnauthorizedOperation.DomainEmpty | Authentication error. |
文档反馈