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.
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. required. each element format is as follows:. http://www.example.com/example.txt. Note: the number of submitted tasks is limited by the quota of a billing package. check the EO billing package. |
| Mode | No | String | Preheat mode. valid values:. Notes:. Preheating to the edge generates edge layer traffic, which is included in billing traffic. 2. specifies the default allocation of edge preheating as a separate preheating amount of 1000 per day, which does not consume the standard preheating amount. Description:. This parameter is the allowlist feature. if needed, contact tencent cloud engineers. |
| Headers.N | No | Array of Header | Specifies whether to carry HTTP header information for preheating. leave it empty otherwise. |
| PrefetchMediaSegments | No | String | Media fragment preheating control. valid values:. Notes:. Supported description file is M3U8; corresponding shard is TS. Specifies the description file must support normal requests and describe sharding paths as per industry standards. Specifies the recursive resolution depth is no more than 3. Parsed shards normally accumulate daily pre-warming amount. when usage exceeds the limit, silent processing is triggered and preheating is no longer executed. Description:. This parameter is the allowlist feature. if needed, contact tencent cloud engineers. |
| 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. |
The example shows you how to submit a pre-warming task.
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
}
{
"Response": {
"JobId": "20ga521cpwch",
"FailedList": [],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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.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. |
文档反馈