tencent cloud

Feedback

CreatePrefetchTask

Last updated: 2022-09-01 15:05:40

1. API Description

Domain name for API request: teo.tencentcloudapi.com.

This API is used to create a pre-warming task.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CreatePrefetchTask.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ZoneId Yes String ID of the site
Targets.N No Array of String List of resources to be pre-warmed, for example:
http://www.example.com/example.txt
EncodeUrl No Boolean Specifies whether to encode the URL
Note that if it’s enabled, the purging is based on the converted URLs.
Headers.N No Array of Header HTTP header information

3. Output Parameters

Parameter Name Type Description
JobId String Task ID
FailedList Array of FailReason List of failed tasks
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Pre-warming URLs

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrefetchTask
<Common request parameters>

{
    "Targets": [
        "http://www.qq.com/a.txt",
        "www.qq.com/1.txt"
    ],
    "ZoneId": "abc",
    "EncodeUrl": true
}

Output Example

{
    "Response": {
        "JobId": "20ga521cpwch",
        "FailedList": [],
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.BackendError Server error.
InternalError.DomainConfig Failed to get configuration
InternalError.FailedToGenerateUrl Failed to generate an upload link.
InternalError.QuotaSystem Server error.
InvalidParameter.DomainNotFound The domain name does not exist or not belong to this account.
InvalidParameter.ParameterError Invalid parameter
InvalidParameter.Target Resource error
InvalidParameter.TaskNotGenerated Failed to create the task
InvalidParameter.UploadUrl Invalid file upload link.
LimitExceeded.BatchQuota Reached the upper limit of resource number
LimitExceeded.DailyQuota Reached the daily upper limit of resource number
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support