Updated on 2024-07-05 GMT+08:00

Creating a Cache Purge Task

Function

This API is used to create a cache purge task.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/cdn/content/refresh-tasks

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project to which the cache purge 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

Table 2 Request header 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

refresh_task

Yes

RefreshTaskRequestBody object

Cache purge settings.

Table 4 RefreshTaskRequestBody

Parameter

Mandatory

Type

Description

type

No

String

Type of cached content to be purged. Possible values: file and directory. Default value: file.

mode

No

String

Directory purge mode. Possible values: all (refresh all resources in the directory) and detect_modify_refresh (refresh changed resources in the directory). The default value is all.

zh_url_encode

No

Boolean

Whether to encode Chinese characters in URLs before cache purge. Possible values: false (disabled, default value) and true (enabled). After this function is enabled, cache is purged 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 or 100 directories and separate them by commas (,), for example. url1, url2.

NOTE:
  • If a URL contains Chinese characters, refresh both this URL (zh_url_encode disabled) and its encoded URL (zh_url_encode enabled).

  • If a URL contains spaces, escape spaces in the URL and disable URL Encode.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

refresh_task

String

Task ID.

Example Requests

POST https://cdn.myhuaweicloud.com/v1.0/cdn/content/refresh-tasks?enterprise_project_id=0

{
  "refresh_task" : {
    "type" : "file",
    "urls" : [ "https://www.bxxx/1.txt", "http://www.bxxx/2.txt" ]
  }
}

Example Responses

Status code: 200

OK

{
  "refresh_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
56
57
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 CreateRefreshTasksSolution {

    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();
        CreateRefreshTasksRequest request = new CreateRefreshTasksRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        RefreshTaskRequest body = new RefreshTaskRequest();
        List<String> listRefreshTaskUrls = new ArrayList<>();
        listRefreshTaskUrls.add("https://www.bxxx/1.txt");
        listRefreshTaskUrls.add("http://www.bxxx/2.txt");
        RefreshTaskRequestBody refreshTaskbody = new RefreshTaskRequestBody();
        refreshTaskbody.withType(RefreshTaskRequestBody.TypeEnum.fromValue("file"))
            .withUrls(listRefreshTaskUrls);
        body.withRefreshTask(refreshTaskbody);
        request.withBody(body);
        try {
            CreateRefreshTasksResponse response = client.createRefreshTasks(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
41
42
# 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 = CreateRefreshTasksRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        listUrlsRefreshTask = [
            "https://www.bxxx/1.txt",
            "http://www.bxxx/2.txt"
        ]
        refreshTaskbody = RefreshTaskRequestBody(
            type="file",
            urls=listUrlsRefreshTask
        )
        request.body = RefreshTaskRequest(
            refresh_task=refreshTaskbody
        )
        response = client.create_refresh_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
46
47
48
49
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.CreateRefreshTasksRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	var listUrlsRefreshTask = []string{
        "https://www.bxxx/1.txt",
	    "http://www.bxxx/2.txt",
    }
	typeRefreshTask:= model.GetRefreshTaskRequestBodyTypeEnum().FILE
	refreshTaskbody := &model.RefreshTaskRequestBody{
		Type: &typeRefreshTask,
		Urls: listUrlsRefreshTask,
	}
	request.Body = &model.RefreshTaskRequest{
		RefreshTask: refreshTaskbody,
	}
	response, err := client.CreateRefreshTasks(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.