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

创建预热缓存任务

功能介绍

创建预热任务。

调用方法

请参见如何调用API

URI

POST /v1.0/cdn/content/preheating-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参数

参数

是否必选

参数类型

描述

preheating_task

PreheatingTaskRequestBody object

缓存预热设置。

表4 PreheatingTaskRequestBody

参数

是否必选

参数类型

描述

zh_url_encode

Boolean

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

urls

Array of strings

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

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

preheating_task

String

任务ID。

请求示例

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

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

响应示例

状态码: 200

OK

{
  "preheating_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
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 CreatePreheatingTasksSolution {

    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();
        CreatePreheatingTasksRequest request = new CreatePreheatingTasksRequest();
        PreheatingTaskRequest body = new PreheatingTaskRequest();
        List<String> listPreheatingTaskUrls = new ArrayList<>();
        listPreheatingTaskUrls.add("https://www.bxxx/1.txt");
        listPreheatingTaskUrls.add("http://www.bxxx/2.txt");
        PreheatingTaskRequestBody preheatingTaskbody = new PreheatingTaskRequestBody();
        preheatingTaskbody.withUrls(listPreheatingTaskUrls);
        body.withPreheatingTask(preheatingTaskbody);
        request.withBody(body);
        try {
            CreatePreheatingTasksResponse response = client.createPreheatingTasks(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 = CreatePreheatingTasksRequest()
        listUrlsPreheatingTask = [
            "https://www.bxxx/1.txt",
            "http://www.bxxx/2.txt"
        ]
        preheatingTaskbody = PreheatingTaskRequestBody(
            urls=listUrlsPreheatingTask
        )
        request.body = PreheatingTaskRequest(
            preheating_task=preheatingTaskbody
        )
        response = client.create_preheating_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
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.CreatePreheatingTasksRequest{}
	var listUrlsPreheatingTask = []string{
        "https://www.bxxx/1.txt",
	    "http://www.bxxx/2.txt",
    }
	preheatingTaskbody := &model.PreheatingTaskRequestBody{
		Urls: listUrlsPreheatingTask,
	}
	request.Body = &model.PreheatingTaskRequest{
		PreheatingTask: preheatingTaskbody,
	}
	response, err := client.CreatePreheatingTasks(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

错误码

请参见错误码