文档首页/ 内容分发网络 CDN/ API参考/ API/ 刷新预热/ 创建封禁/解禁URL任务 - CreateAccessControlTask
更新时间:2026-01-09 GMT+08:00
分享

创建封禁/解禁URL任务 - CreateAccessControlTask

功能介绍

创建封禁/解禁URL任务,如需使用本接口,请提交工单申请。

  • 单租户调用频率:10次/s。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1.0/cdn/content/access-control-urls/{action}

表1 路径参数

参数

是否必选

参数类型

描述

action

String

参数解释:

操作类型,

约束限制:

不涉及

取值范围:

  • ban:禁用

  • unban:解禁

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

access_control_urls

AccessControlUrls object

需要解禁或封禁的URL信息

表4 AccessControlUrls

参数

是否必选

参数类型

描述

urls

Array of strings

URL必须带有“http://”或“https://”,单次最多输入1000个url。

ban_duration

Integer

URL封禁天数,默认7天,取值范围1-30。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

task_id

String

任务id

状态码:400

表6 响应Body参数

参数

参数类型

描述

error

ErrMsg object

用于返回具体的错误码和错误消息

表7 ErrMsg

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://cdn.myhuaweicloud.com/v1.0/cdn/content/access-control-urls/ban

{
  "access_control_urls" : {
    "urls" : [ "https://www.example.com/1.txt", "http://www.example.com/2.txt" ],
    "ban_duration" : 1
  }
}

响应示例

状态码:200

成功响应。

{
  "task_id" : "71xxxxxxxxxxxxxxxxxxxxxxxxxxxxff"
}

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
57
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 CreateAccessControlTaskSolution {

    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();
        CreateAccessControlTaskRequest request = new CreateAccessControlTaskRequest();
        request.withAction("{action}");
        UrlAccessControlTaskRequestBody body = new UrlAccessControlTaskRequestBody();
        List<String> listAccessControlUrlsUrls = new ArrayList<>();
        listAccessControlUrlsUrls.add("https://www.example.com/1.txt");
        listAccessControlUrlsUrls.add("http://www.example.com/2.txt");
        AccessControlUrls accessControlUrlsbody = new AccessControlUrls();
        accessControlUrlsbody.withUrls(listAccessControlUrlsUrls)
            .withBanDuration(1);
        body.withAccessControlUrls(accessControlUrlsbody);
        request.withBody(body);
        try {
            CreateAccessControlTaskResponse response = client.createAccessControlTask(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
42
# 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 = CreateAccessControlTaskRequest()
        request.action = "{action}"
        listUrlsAccessControlUrls = [
            "https://www.example.com/1.txt",
            "http://www.example.com/2.txt"
        ]
        accessControlUrlsbody = AccessControlUrls(
            urls=listUrlsAccessControlUrls,
            ban_duration=1
        )
        request.body = UrlAccessControlTaskRequestBody(
            access_control_urls=accessControlUrlsbody
        )
        response = client.create_access_control_task(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
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.CreateAccessControlTaskRequest{}
	request.Action = "{action}"
	var listUrlsAccessControlUrls = []string{
        "https://www.example.com/1.txt",
	    "http://www.example.com/2.txt",
    }
	banDurationAccessControlUrls:= int32(1)
	accessControlUrlsbody := &model.AccessControlUrls{
		Urls: listUrlsAccessControlUrls,
		BanDuration: &banDurationAccessControlUrls,
	}
	request.Body = &model.UrlAccessControlTaskRequestBody{
		AccessControlUrls: accessControlUrlsbody,
	}
	response, err := client.CreateAccessControlTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功响应。

400

失败响应。

错误码

请参见错误码

相关文档