Domain name for API request: teo.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 | ZoneId. The parameter is required. |
StartTime | No | Timestamp ISO8601 | Start time of the query. |
EndTime | No | Timestamp ISO8601 | End time of the query. |
Offset | No | Integer | Offset for paginated queries. Default value: 0 . |
Limit | No | Integer | Limit on paginated queries. Default value: 20 . Maximum value: 1000 . |
Filters.N | No | Array of AdvancedFilter | Filtering condition. The maximum value of Filters.Values is 20. Detailed filtering conditions: u2003u2003 Filter based on [task ID]. job-id format: 1379afjk91u32h. Multiple values are not supported. u2003u2003 Type: String u2003u2003 Required: No. u2003u2003 Fuzz query: Not supported. u2003u2003 Filter based on [target resource information]. target format: http://www.qq.com/1.txt. Multiple values are not supported. u2003u2003 Type: String u2003u2003 Required: No. u2003u2003 Fuzz query: Not supported. u2003u2003 Filter based on [domain name]. domains format: www.qq.com. u2003u2003 Type: String u2003u2003 Required: No. u2003u2003 Fuzz query: Not supported. u2003u2003 Filter based on [task status]. u2003u2003 Required: No u2003u2003 Fuzz query: Not supported. u2003u2003 Options: u2003u2003 processing: Processing u2003u2003 success: Success u2003u2003 failed: Failure u2003u2003 timeout: Timeout |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total entries that match the specified query condition. |
Tasks | Array of Task | List of tasks returned. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
After the preheating task is submitted by using CreatePrefetchTasks, use this API to query the preheating task records and execution progress.
POST / HTTP/1.1
Host: teo.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": 1,
"Offset": 7
}
{
"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
}
}
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. |
Was this page helpful?