Creating a Cache Prefetch Task
Function
This API is used to create a cache prefetch task.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/cdn/content/preheating-tasks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
ID of the enterprise project to which the cache prefetch task is added. This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects. This parameter is mandatory when you use an IAM user to call this API. Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
preheating_task |
Yes |
PreheatingTaskRequestBody object |
Cache prefetch settings. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
zh_url_encode |
No |
Boolean |
Whether to encode Chinese characters in URLs before cache prefetch. Possible values: false (disabled, default value) and true (enabled). After this function is enabled, cache is prefetched only for transcoded URLs. |
urls |
Yes |
Array of strings |
A URL must contain http:// or https://. A URL can contain up to 4,096 characters. Enter up to 1,000 URLs and separate them by commas (,), for example. url1, url2. Currently, directory prefetch is not supported. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
preheating_task |
String |
Task ID. |
Example Requests
POST https://cdn.myhuaweicloud.com/v1.0/cdn/content/preheating-tasks?enterprise_project_id=0 { "preheating_task" : { "urls" : [ "https://www.bxxx/1.txt", "http://www.bxxx/2.txt" ] } }
Example Responses
Status code: 200
OK
{ "preheating_task" : "7620242" }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cdn.v2.region.CdnRegion; import com.huaweicloud.sdk.cdn.v2.*; import com.huaweicloud.sdk.cdn.v2.model.*; import java.util.List; import java.util.ArrayList; public class CreatePreheatingTasksSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CdnClient client = CdnClient.newBuilder() .withCredential(auth) .withRegion(CdnRegion.valueOf("<YOUR REGION>")) .build(); CreatePreheatingTasksRequest request = new CreatePreheatingTasksRequest(); PreheatingTaskRequest body = new PreheatingTaskRequest(); List<String> listPreheatingTaskUrls = new ArrayList<>(); listPreheatingTaskUrls.add("https://www.bxxx/1.txt"); listPreheatingTaskUrls.add("http://www.bxxx/2.txt"); PreheatingTaskRequestBody preheatingTaskbody = new PreheatingTaskRequestBody(); preheatingTaskbody.withUrls(listPreheatingTaskUrls); body.withPreheatingTask(preheatingTaskbody); request.withBody(body); try { CreatePreheatingTasksResponse response = client.createPreheatingTasks(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcdn.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = CdnClient.new_builder() \ .with_credentials(credentials) \ .with_region(CdnRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreatePreheatingTasksRequest() listUrlsPreheatingTask = [ "https://www.bxxx/1.txt", "http://www.bxxx/2.txt" ] preheatingTaskbody = PreheatingTaskRequestBody( urls=listUrlsPreheatingTask ) request.body = PreheatingTaskRequest( preheating_task=preheatingTaskbody ) response = client.create_preheating_tasks(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cdn.NewCdnClient( cdn.CdnClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreatePreheatingTasksRequest{} var listUrlsPreheatingTask = []string{ "https://www.bxxx/1.txt", "http://www.bxxx/2.txt", } preheatingTaskbody := &model.PreheatingTaskRequestBody{ Urls: listUrlsPreheatingTask, } request.Body = &model.PreheatingTaskRequest{ PreheatingTask: preheatingTaskbody, } response, err := client.CreatePreheatingTasks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot