Help Center/ Content Delivery Network/ API Reference/ API/ Cache Purge and Prefetch/ Querying a Cache Purge or Prefetch Task
Updated on 2024-09-04 GMT+08:00

Querying a Cache Purge or Prefetch Task

Function

This API is used to query details about a cache purge or prefetch task.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/cdn/historytasks/{history_tasks_id}/detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

history_tasks_id

Yes

String

ID of a cache purge or prefetch task.

Table 2 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 URLs for purge and prefetch 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

URL status. Possible values: processing, succeed, failed, waiting, refreshing, and preheating.

url

No

String

URL of the purged or prefetched content.

create_time

No

Long

Time when a task was created. If this parameter is not passed, tasks within the last seven days are queried by default. Data within the last 15 days can be queried.

Request Parameters

Table 3 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 4 Response body parameters

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. Possible values: task_done (successful) and task_inprocess (processing).

urls

Array of UrlObject objects

URL list.

create_time

Long

Creation time.

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.

file_type

String

File type. Possible values: file (default value) and directory.

Table 5 UrlObject

Parameter

Type

Description

id

String

URL ID.

url

String

URL of the purged or prefetched content.

status

String

URL status. Possible values: processing, succeed, failed, waiting, refreshing, and preheating.

create_time

Long

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

task_id

String

Task ID.

task_type

String

Task type. Possible values: REFRESH (purge), PREHEATING (prefetch), or REFRESH_AFTER_PREHEATING (purge after prefetch).

fail_classify

String

Failure cause. This parameter is returned when the URL status is failed.

  • ORIGIN_ERROR: origin server error.

  • INNER_ERROR: internal error.

  • UNKNOWN_ERROR: unknown error.

fail_desc

String

Description of the cache purge/prefetch failure.

Example Requests

GET https://cdn.myhuaweicloud.com/v1.0/cdn/historytasks/ff808***********************b39/detail?page_size=10&page_number=1&enterprise_project_id=0

Example Responses

Status code: 200

OK

{
  "id" : "ff80808xxxxxxxxx64797",
  "status" : "task_inprocess",
  "processing" : 2,
  "succeed" : 0,
  "failed" : 0,
  "urls" : [ {
    "url" : "http://www.example1.example2.com/index.html",
    "id" : "ff80808264exxxxxxxxx60c4fe74798",
    "status" : "processing",
    "create_time" : 1532867923942,
    "task_id" : "ff80808xxxxxxxxx64797",
    "task_type" : "PREHEATING"
  }, {
    "url" : "http://www.example1.example2.com/web",
    "id" : "ff80808*******************4799",
    "status" : "processing",
    "create_time" : 1532867923942,
    "task_id" : "ff80808xxxxxxxxx64797",
    "task_type" : "PREHEATING"
  } ],
  "task_type" : "preheating",
  "total" : 2,
  "create_time" : 1532867923942,
  "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
46
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 ShowHistoryTaskDetailsSolution {

    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();
        ShowHistoryTaskDetailsRequest request = new ShowHistoryTaskDetailsRequest();
        request.withHistoryTasksId("{history_tasks_id}");
        try {
            ShowHistoryTaskDetailsResponse response = client.showHistoryTaskDetails(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
# 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 = ShowHistoryTaskDetailsRequest()
        request.history_tasks_id = "{history_tasks_id}"
        response = client.show_history_task_details(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
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.ShowHistoryTaskDetailsRequest{}
	request.HistoryTasksId = "{history_tasks_id}"
	response, err := client.ShowHistoryTaskDetails(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.