CreatePrefetchTask

Last updated: 2025-10-30 22:02:56

CreatePrefetchTask

Last updated: 2025-10-30 22:02:56

1. API Description

Domain name for API request: teo.intl.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-09-01.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Zone ID. If you wish to quickly submit Targets urls under different sites, you can fill in * as the value. but the premise is that the account calling this API must have the permission to all site resources under the root account.
Targets.N	No	Array of String	List of resources to be preheated. Each element format is similar to the following: http://www.example.com/example.txt. The parameter value is currently required. Note: The number of tasks that can be submitted is limited by the quota of a billing package. For details, see [Billing Overview] (https://www.tencentcloud.com/document/product/1552/77380?from_cn_redirect=1).
Headers.N	No	Array of Header	HTTP header information
PrefetchMediaSegments	No	String	Media fragment preheating control. valid values:. On: enables shard preheating, preheats the description file, and performs recursive resolution of the description file shards for preheating. . Off: only preheat the submitted description file. default value: off if left empty. Notes:. 1. the supported description file is M3U8, and the corresponding shard is TS. Describes the requirement that the description file can process normal requests and specify the sharding path as per industry standards. Recursive resolution depth is no more than 3. Parsed shards normally accumulate daily pre-warming amount. when usage exceeds the quota limit, silent processing is triggered and preheating is no longer executed. This parameter specifies the allowlist feature. if necessary, contact tencent cloud engineers.

3. Output Parameters

Parameter Name	Type	Description
JobId	String	ID of the task.
FailedList	Array of FailReason	List of failed tasks. Note: This field may return null, indicating that no valid values can be obtained.
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.

4. Example

Example1 Pre-warming a URL

The example shows you how to submit a pre-warming task.

Input Example

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

{
    "Targets": [
        "http://www.qq.com/a.txt"
    ],
    "ZoneId": "zone-ajj243dwrew",
    "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

Tencent Cloud CLI 3.0

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 is not belong to this account.
InvalidParameter.ParameterError	Parameter error: Invalid “End time”. The interval between the start and end time cannot exceed 7 days.
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
UnauthorizedOperation.CamUnauthorized	CAM is not authorized.
UnauthorizedOperation.NoPermission	The sub-account is not authorized for the operation. Please get permissions first.
UnauthorizedOperation.Unknown	An unknown error occurred in the backend server.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud