文档首页/ 内容分发网络 CDN/ API参考/ API/ 刷新预热/ 查询刷新预热任务详情
更新时间:2024-09-04 GMT+08:00

查询刷新预热任务详情

功能介绍

查询刷新预热任务详情。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

history_tasks_id

String

刷新预热任务ID。

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

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

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

page_size

Integer

刷新预热的urls所显示单页最大数量,取值范围为1-10000。page_size和page_number必须同时传值。默认值30。

page_number

Integer

刷新预热的urls当前查询为第几页,取值范围为1-65535。默认值1。

status

String

url的状态 processing 处理中,succeed 完成,failed 失败,waiting 等待,refreshing 刷新中,preheating 预热中。

url

String

刷新预热url地址。

create_time

Long

刷新预热任务的创建时间。不传参默认为查询7天内的任务。最长可查询15天内数据。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

任务id。

task_type

String

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

status

String

任务执行结果,task_done:成功,task_inprocess:处理中。

urls

Array of UrlObject objects

本次提交的url列表。

create_time

Long

创建时间。

processing

Integer

处理中的url个数。

succeed

Integer

成功处理的url个数。

failed

Integer

处理失败的url个数。

total

Integer

总的url个数。

file_type

String

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

表5 UrlObject

参数

参数类型

描述

id

String

url的id

url

String

刷新预热url。

status

String

url的状态 processing 处理中,succeed 完成,failed 失败,waiting 等待,refreshing 刷新中,preheating 预热中。

create_time

Long

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

task_id

String

任务id。

task_type

String

任务的类型, 其值可以为REFRESH:刷新任务、PREHEATING:预热任务、REFRESH_AFTER_PREHEATING:预热后刷新

fail_classify

String

失败原因,url状态为failed时返回。

  • ORIGIN_ERROR:源站错误。

  • INNER_ERROR:内部错误。

  • UNKNOWN_ERROR:未知错误。

fail_desc

String

刷新预热失败描述。

请求示例

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

响应示例

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

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
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)
    }
}

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

状态码

状态码

描述

200

OK

错误码

请参见错误码