tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud EdgeOne
    Documentation
    Download PDF

    CreatePrefetchTask

    Last updated: 2023-12-01 15:19:08
    Download PDF

      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-09-01.
      Region No String Common Params. This parameter is not required.
      ZoneId Yes String ID of the site.
      Targets.N No Array of String Resources to be pre-warmed, for example:
      http://www.example.com/example.txt
      Note: The number of submitted tasks is limited by the quota of the plan. For details, see Billing Overview.
      EncodeUrl No Boolean Whether to encode a URL according to RFC3986. Enable this field when the URL contains non-ASCII characters.
      Headers.N No Array of Header HTTP header information

      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, which is returned for each request. 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.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

      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.
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2023 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy