文档首页/ 内容分发网络 CDN/ API参考/ API/ 刷新预热/ 查询刷新预热URL记录
更新时间:2024-10-18 GMT+08:00
分享

查询刷新预热URL记录

功能介绍

查询刷新预热URL记录。如需此接口,请提交工单开通。

调用方法

请参见如何调用API

URI

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

表1 Query参数

参数

是否必选

参数类型

描述

start_time

Long

查询起始时间戳(毫秒),不传默认当天00:00,需与结束时间戳同时指定,时间跨度不能超过24小时。

end_time

Long

查询结束时间戳(毫秒),不传默认次日00:00,需与开始时间戳同时指定,时间跨度不能超过24小时。

offset

Integer

偏移量:特定数据字段与起始数据字段位置的距离,默认为0。

limit

Integer

单次查询数据条数,上限为100,默认为10。

url

String

刷新预热url。

task_type

String

任务类型,REFRESH:刷新任务;PREHEATING:预热任务。

status

String

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

file_type

String

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

请求参数

响应参数

状态码: 200

表2 响应Header参数

参数

参数类型

描述

X-request-id

String

任务请求ID.

表3 响应Body参数

参数

参数类型

描述

total

Integer

查询结果总数。

count

Integer

当前页的总数。

result

Array of urls objects

url信息。

表4 urls

参数

参数类型

描述

id

Long

url id。

url

String

url具体值。

status

String

url状态,状态类型:PROCESSING:处理中;SUCCEED:完成;FAILED:失败;WAITING:等待;REFRESHING:刷新中; PREHEATING : 预热中。

type

String

任务类型,REFRESH:刷新任务;PREHEATING:预热任务。

task_id

Long

任务id。

modify_time

Long

修改时间戳(毫秒)。

create_time

Long

创建时间戳(毫秒)。

file_type

String

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

mode

String

目录刷新方式,all:刷新目录下全部资源;detect_modify_refresh:刷新目录下已变更的资源。

状态码: 400

表5 响应Header参数

参数

参数类型

描述

X-request-id

String

任务请求ID

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

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

响应示例

状态码: 200

查询结果响应样例

{
  "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代码示例

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

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

状态码

状态码

描述

200

查询结果响应样例

400

Error response

错误码

请参见错误码

相关文档