更新时间:2024-07-05 GMT+08:00

查询刷新预热任务

功能介绍

查询刷新预热任务。

调用方法

请参见如何调用API

URI

GET /v1.0/cdn/historytasks

表1 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。

page_size

Integer

单页最大数量,取值范围为1-10000。page_size和page_number必须同时传值。默认值30。

page_number

Integer

当前查询第几页,取值范围为1-65535。默认值1。

status

String

任务状态。 task_inprocess 表示任务处理中,task_done表示任务完成。

start_date

Long

查询起始时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。

end_date

Long

查询结束时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。

order_field

String

用来排序的字段,支持的字段有“task_type”:任务的类型,“total”:url总数,“processing”:处理中的url个数, “succeed”:成功处理的url个数,“failed”:处理失败的url个数,“create_time”:任务的创建时间。order_field和order_type必须同时传值,否则使用默认值"create_time" 和 "desc":降序。

order_type

String

desc:降序,或者asc:升序。默认值desc。

file_type

String

文件类型,file:文件;directory:目录。

task_type

String

任务类型,refresh:刷新任务;preheating:预热任务。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

总共的任务个数。

tasks

Array of TasksObject objects

日志列表数据

表4 TasksObject

参数

参数类型

描述

id

String

任务id。

task_type

String

任务的类型, 其值可以为refresh:刷新任务,或preheating:预热任务。

status

String

任务执行结果,task_done表示成功 ,task_inprocess表示执行中。

processing

Integer

处理中的url个数。

succeed

Integer

成功处理的url个数。

failed

Integer

处理失败的url个数。

total

Integer

url总数。

create_time

Long

任务的创建时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。

file_type

String

文件类型,file:文件;directory:目录。

请求示例

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

响应示例

状态码: 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代码示例

SDK代码示例如下。

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


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();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withPageSize(<page_size>);
        request.withPageNumber(<page_number>);
        request.withStatus(ShowHistoryTasksRequest.StatusEnum.fromValue("<status>"));
        request.withStartDate(<start_date>L);
        request.withEndDate(<end_date>L);
        request.withOrderField("<order_field>");
        request.withOrderType("<order_type>");
        request.withFileType(ShowHistoryTasksRequest.FileTypeEnum.fromValue("<file_type>"));
        request.withTaskType(ShowHistoryTasksRequest.TaskTypeEnum.fromValue("<task_type>"));
        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
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 = ShowHistoryTasksRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.page_size = <page_size>
        request.page_number = <page_number>
        request.status = "<status>"
        request.start_date = <start_date>
        request.end_date = <end_date>
        request.order_field = "<order_field>"
        request.order_type = "<order_type>"
        request.file_type = "<file_type>"
        request.task_type = "<task_type>"
        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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
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{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	pageSizeRequest:= int32(<page_size>)
	request.PageSize = &pageSizeRequest
	pageNumberRequest:= int32(<page_number>)
	request.PageNumber = &pageNumberRequest
	statusRequest:= model.GetShowHistoryTasksRequestStatusEnum().<STATUS>
	request.Status = &statusRequest
	startDateRequest:= int64(<start_date>)
	request.StartDate = &startDateRequest
	endDateRequest:= int64(<end_date>)
	request.EndDate = &endDateRequest
	orderFieldRequest:= "<order_field>"
	request.OrderField = &orderFieldRequest
	orderTypeRequest:= "<order_type>"
	request.OrderType = &orderTypeRequest
	fileTypeRequest:= model.GetShowHistoryTasksRequestFileTypeEnum().<FILE_TYPE>
	request.FileType = &fileTypeRequest
	taskTypeRequest:= model.GetShowHistoryTasksRequestTaskTypeEnum().<TASK_TYPE>
	request.TaskType = &taskTypeRequest
	response, err := client.ShowHistoryTasks(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码