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

Querying Cache Purge and Prefetch Records

Function

This API is used to query cache purge and prefetch records. To use this API, submit a service ticket.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/cdn/contentgateway/url-tasks

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

start_time

No

Long

Query start timestamp, in milliseconds. The default value is 00:00 of the current day. The start timestamp and end timestamp must be specified at the same time and the time span between them cannot exceed 24 hours.

end_time

No

Long

Query end timestamp, in milliseconds. The default value is 00:00 of the next day. The end timestamp and start timestamp must be specified at the same time and the time span between them cannot exceed 24 hours.

offset

No

Integer

Offset, which is the distance between a specific data field and the start data field. Default value: 0.

limit

No

Integer

Number of data records queried at a time. Maximum value: 100. Default value: 10.

url

No

String

URL purged or prefetched.

task_type

No

String

Task type. Possible values: REFRESH (cache purge) and PREHEATING (cache prefetch).

status

No

String

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

file_type

No

String

File type. Possible values: file and directory.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response header parameters

Parameter

Type

Description

X-request-id

String

Task request ID.

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of queried records.

count

Integer

Total number of records on the current page.

result

Array of urls objects

URL information.

Table 4 urls

Parameter

Type

Description

id

Long

URL ID.

url

String

URL.

status

String

URL status. Possible values: PROCESSING, SUCCEED, FAILED, WAITING, REFRESHING (purging), and PREHEATING (prefetching).

type

String

Task type. Possible values: REFRESH (cache purge) and PREHEATING (cache prefetch).

task_id

Long

Task ID.

modify_time

Long

Modification timestamp, in milliseconds.

create_time

Long

Creation timestamp, in milliseconds.

file_type

String

File type. Possible values: file and directory.

mode

String

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

Status code: 400

Table 5 Response header parameters

Parameter

Type

Description

X-request-id

String

Task request ID.

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://cdn.myhuaweicloud.com/v1.0/cdn/contentgateway/url-tasks?&status=processing

Example Responses

Status code: 200

Query result response example

{
  "total" : 31548,
  "count" : 10,
  "result" : [ {
    "id" : 8992619,
    "url" : "https://scxximwp.qqeixmbe.com/test.jpg",
    "status" : "SUCCEED",
    "type" : "REFRESH",
    "task_id" : 407354,
    "modify_time" : 1652325742000,
    "create_time" : 1652325740318,
    "file_type" : "file"
  }, {
    "id" : 8992618,
    "url" : "https://obut8gmc.qqeixmbe.com/test.jpg",
    "status" : "SUCCEED",
    "type" : "REFRESH",
    "task_id" : 407353,
    "modify_time" : 1652325711000,
    "create_time" : 1652325708268,
    "file_type" : "file"
  }, {
    "id" : 8992617,
    "url" : "https://scxximwp.qqeixmbe.com/test.jpg",
    "status" : "SUCCEED",
    "type" : "REFRESH",
    "task_id" : 407353,
    "modify_time" : 1652325711000,
    "create_time" : 1652325708268,
    "file_type" : "file"
  }, {
    "id" : 8992616,
    "url" : "http://content-hw.autotest.com/autotest/DQCkkgmV",
    "status" : "PROCESSING",
    "type" : "REFRESH",
    "task_id" : 407352,
    "modify_time" : 1652325672000,
    "create_time" : 1652325671917,
    "file_type" : "file"
  }, {
    "id" : 8992615,
    "url" : "http://content-hw.autotest.com/autotest/dQSF5jEx",
    "status" : "PROCESSING",
    "type" : "REFRESH",
    "task_id" : 407352,
    "modify_time" : 1652325672000,
    "create_time" : 1652325671917,
    "file_type" : "file"
  }, {
    "id" : 8992614,
    "url" : "http://content-hw.autotest.com/autotest/quN2l1oh",
    "status" : "PROCESSING",
    "type" : "REFRESH",
    "task_id" : 407352,
    "modify_time" : 1652325672000,
    "create_time" : 1652325671917,
    "file_type" : "file"
  }, {
    "id" : 8992613,
    "url" : "http://content-hw.autotest.com/autotest/Wgk3AKVu",
    "status" : "PROCESSING",
    "type" : "REFRESH",
    "task_id" : 407352,
    "modify_time" : 1652325672000,
    "create_time" : 1652325671917,
    "file_type" : "file"
  }, {
    "id" : 8992612,
    "url" : "http://content-hw.autotest.com/autotest/jg1cv1vV",
    "status" : "PROCESSING",
    "type" : "REFRESH",
    "task_id" : 407352,
    "modify_time" : 1652325672000,
    "create_time" : 1652325671917,
    "file_type" : "file"
  }, {
    "id" : 8992611,
    "url" : "http://content-hw.autotest.com/autotest/DTxFfv6f",
    "status" : "PROCESSING",
    "type" : "REFRESH",
    "task_id" : 407352,
    "modify_time" : 1652325672000,
    "create_time" : 1652325671917,
    "file_type" : "file"
  }, {
    "id" : 8992610,
    "url" : "http://content-hw.autotest.com/autotest/g8QYHTY4",
    "status" : "PROCESSING",
    "type" : "REFRESH",
    "task_id" : 407352,
    "modify_time" : 1652325672000,
    "create_time" : 1652325671917,
    "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 ShowUrlTaskInfoSolution {

    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();
        ShowUrlTaskInfoRequest request = new ShowUrlTaskInfoRequest();
        try {
            ShowUrlTaskInfoResponse response = client.showUrlTaskInfo(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 = ShowUrlTaskInfoRequest()
        response = client.show_url_task_info(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.ShowUrlTaskInfoRequest{}
	response, err := client.ShowUrlTaskInfo(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

Query result response example

400

Error response

Error Codes

See Error Codes.