Help Center/ Content Delivery Network/ API Reference/ API/ Cache Purge and Prefetch/ Querying Cache Purge and Prefetch Tasks
Updated on 2024-10-30 GMT+08:00

Querying Cache Purge and Prefetch Tasks

Function

This API is used to query cache purge and prefetch tasks.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/cdn/historytasks

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project to which the resource belongs. 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).

page_size

No

Integer

Maximum number of records on each page. The value ranges from 1 to 10,000. Both page_size and page_number must be set. Default value: 30.

page_number

No

Integer

Number of the page to be queried. The value ranges from 1 to 65,535. Default value: 1.

status

No

String

Task status. task_inprocess: The task is being processed. task_done: The task is completed.

start_date

No

Long

Query start time. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970).

end_date

No

Long

Query end time. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970).

order_field

No

String

Field used for sorting. Supported fields include task_type (task type), total (total number of URLs), processing (number of URLs that are being processed), succeed (number of processed URLs), failed (number of URLs that fail to be processed), and create_time (task creation time). Both order_field and order_type must be set. Otherwise, the default values create_time and desc are used.

order_type

No

String

desc: descending order; asc: ascending order. Default value: desc.

file_type

No

String

File type. Possible values: file and directory.

task_type

No

String

Task type. Possible values: refresh (cache purge) and preheating (cache prefetch).

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of tasks.

tasks

Array of TasksObject objects

Log list.

Table 4 TasksObject

Parameter

Type

Description

id

String

Task ID.

task_type

String

Task type. Possible values: refresh (cache purge) and preheating (cache prefetch).

status

String

Task execution result. task_done: The task is executed. task_inprocess: The task is being executed.

processing

Integer

Number of URLs that are being processed.

succeed

Integer

Number of URLs processed.

failed

Integer

Number of URLs that failed to be processed.

total

Integer

Total number of URLs in the task.

create_time

Long

Time when the task was created. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970).

file_type

String

File type. Possible values: file and directory.

Example Requests

GET https://cdn.myhuaweicloud.com/v1.0/cdn/historytasks?status=task_inprocess&page_size=30&page_number=1&enterprise_project_id=0

Example Responses

Status code: 200

OK

{
  "total" : 2,
  "tasks" : [ {
    "id" : "ff8080xxxxxxxxxxxxd816ff0128",
    "status" : "task_inprocess",
    "processing" : 2,
    "succeed" : 0,
    "failed" : 0,
    "task_type" : "refresh",
    "total" : 2,
    "create_time" : 1534240233215,
    "file_type" : "file"
  }, {
    "id" : "ff8080xxxxxxxxxxx4fe64797",
    "status" : "task_inprocess",
    "processing" : 1,
    "succeed" : 0,
    "failed" : 0,
    "task_type" : "refresh",
    "total" : 1,
    "create_time" : 1534240219944,
    "file_type" : "file"
  } ]
}

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
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.*;


public class ShowHistoryTasksSolution {

    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();
        ShowHistoryTasksRequest request = new ShowHistoryTasksRequest();
        try {
            ShowHistoryTasksResponse response = client.showHistoryTasks(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
# 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 = ShowHistoryTasksRequest()
        response = client.show_history_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
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.ShowHistoryTasksRequest{}
	response, err := client.ShowHistoryTasks(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.