更新时间:2024-09-04 GMT+08:00

创建刷新缓存任务

功能介绍

创建刷新缓存任务。

调用方法

请参见如何调用API

URI

POST /v1.0/cdn/content/refresh-tasks

表1 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

当用户开启企业项目功能时,该参数生效,表示在当前企业项目下添加缓存刷新任务,"all"代表所有项目。注意:当使用子账号调用接口时,该参数必传。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

refresh_task

RefreshTaskRequestBody object

缓存刷新设置。

表4 RefreshTaskRequestBody

参数

是否必选

参数类型

描述

type

String

刷新的类型,其值可以为file:文件,或directory:目录,默认为file。

mode

String

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

zh_url_encode

Boolean

是否对url中的中文字符进行编码后刷新,默认值为false。false代表不开启,true代表开启,开启后仅刷新转码后的URL。

urls

Array of strings

需要刷新的URL必须带有“http://”或“https://”,多个URL用逗号分隔("url1", "url2"),单个url的长度限制为4096字符,单次最多输入1000个url,如果输入的是目录,支持100个目录刷新。

说明:
  • 如果您需要刷新的URL中有中文,请同时刷新中文URL(输入中文URL且不开启zh_url_encode)和转码后的URL(输入中文URL且开启zh_url_encode)。

  • 如果您的URL中带有空格,请自行转码后输入,且不要开启URL Encode。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

refresh_task

String

任务ID。

请求示例

POST https://cdn.myhuaweicloud.com/v1.0/cdn/content/refresh-tasks?enterprise_project_id=0

{
  "refresh_task" : {
    "type" : "file",
    "urls" : [ "https://www.bxxx/1.txt", "http://www.bxxx/2.txt" ]
  }
}

响应示例

状态码: 200

OK

{
  "refresh_task" : "7620242"
}

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

import java.util.List;
import java.util.ArrayList;

public class CreateRefreshTasksSolution {

    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();
        CreateRefreshTasksRequest request = new CreateRefreshTasksRequest();
        RefreshTaskRequest body = new RefreshTaskRequest();
        List<String> listRefreshTaskUrls = new ArrayList<>();
        listRefreshTaskUrls.add("https://www.bxxx/1.txt");
        listRefreshTaskUrls.add("http://www.bxxx/2.txt");
        RefreshTaskRequestBody refreshTaskbody = new RefreshTaskRequestBody();
        refreshTaskbody.withType(RefreshTaskRequestBody.TypeEnum.fromValue("file"))
            .withUrls(listRefreshTaskUrls);
        body.withRefreshTask(refreshTaskbody);
        request.withBody(body);
        try {
            CreateRefreshTasksResponse response = client.createRefreshTasks(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
41
# 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 = CreateRefreshTasksRequest()
        listUrlsRefreshTask = [
            "https://www.bxxx/1.txt",
            "http://www.bxxx/2.txt"
        ]
        refreshTaskbody = RefreshTaskRequestBody(
            type="file",
            urls=listUrlsRefreshTask
        )
        request.body = RefreshTaskRequest(
            refresh_task=refreshTaskbody
        )
        response = client.create_refresh_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
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.CreateRefreshTasksRequest{}
	var listUrlsRefreshTask = []string{
        "https://www.bxxx/1.txt",
	    "http://www.bxxx/2.txt",
    }
	typeRefreshTask:= model.GetRefreshTaskRequestBodyTypeEnum().FILE
	refreshTaskbody := &model.RefreshTaskRequestBody{
		Type: &typeRefreshTask,
		Urls: listUrlsRefreshTask,
	}
	request.Body = &model.RefreshTaskRequest{
		RefreshTask: refreshTaskbody,
	}
	response, err := client.CreateRefreshTasks(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

错误码

请参见错误码