Help Center/ Content Delivery Network/ API Reference/ API/ Cache Purge and Prefetch/ Creating a URL Blocking or Unblocking Task
Updated on 2026-01-09 GMT+08:00

Creating a URL Blocking or Unblocking Task

Function

This API is used to create a URL blocking or unblocking task. To use this API, submit a service ticket.

  • A single tenant can call this API 10 times per second.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Definition

Operation type.

Constraints

N/A

Range

  • ban: blocking

  • unban: unblocking

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

access_control_urls

Yes

AccessControlUrls object

Information about the URLs to be unblocked or blocked.

Table 4 AccessControlUrls

Parameter

Mandatory

Type

Description

urls

Yes

Array of strings

A URL must contain http:// or https://. Enter up to 1,000 URLs.

ban_duration

No

Integer

Number of days for blocking URLs. The default value is 7 days. The value ranges from 1 to 30.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

task_id

String

Task ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error

ErrMsg object

Error code and error message.

Table 7 ErrMsg

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

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

Example Responses

Status code: 200

Successful response.

{
  "task_id" : "71xxxxxxxxxxxxxxxxxxxxxxxxxxxxff"
}

SDK Sample Code

The SDK sample code is as follows.

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Successful response.

400

Error response.

Error Codes

See Error Codes.