Deletes the configurations of one or more accelerated domain names at a time.

Note
  • The maximum number of domain names configured at a time is 50.
  • The maximum number of times that each user can call this operation per second is 30.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes BatchDeleteDcdnDomainConfigs

The operation that you want to perform. Set the value to BatchDeleteDcdnDomainConfigs.

DomainNames String Yes example.com

The accelerated domain name. If you need to specify multiple accelerated domain names, separate them with commas (,).

FunctionNames String Yes referer_white_list_set,https_force

The feature list. Separate multiple features with commas (,).

The following table describes the supported features.

FunctionID

Feature name

Parameter description

References

1

referer_white_list_set: configures the referer whitelist for hotlink protection.

refer_domain_allow_list: specifies the referers to be added to the whitelist. Separate multiple referers with commas (,).

allow_empty: specifies whether requests with an empty referer header are allowed to access Dynamic Route for CDN (DCDN) resources. Valid values: on and off.

Configure a referer whitelist or blacklist to enable hotlink protection

5

referer_black_list_set: configures a referer blacklist.

refer_domain_deny_list: specifies the referers to be added to the blacklist. Separate multiple referers with commas (,).

allow_empty: specifies whether requests with an empty referer header are allowed to access DCDN resources. Valid values: on and off.

Configure a referer whitelist or blacklist to enable hotlink protection

6

filetype_based_ttl_set: sets an expiration rule for specific file types.

ttl: specifies the time period after which the cached data expires. Unit: seconds.

file_type: specifies the file types. Separate multiple file types with commas. For example, enter TXT,JPG.

weight: specifies the weight.

Configure cache duration rules

7

path_based_ttl_set: sets an expiration rule for a specific directory.

ttl: specifies the time period after which the cached data expires. Unit: seconds.

path: specifies a path. It must start with a forward slash (/).

weight: specifies the weight.

Configure cache duration rules

10

oss_auth: configures authentication for requests destined for an Object Storage Service (OSS) bucket.

oss_bucket_id: specifies the endpoint of the OSS bucket.

If the origin server is an OSS bucket, authentication is automatically configured.

13

ip_black_list_set: configures an IP address blacklist.

ip_list: specifies the IP addresses to be added to the whitelist. Separate multiple IP addresses with commas (,).

Configure an IP address blacklist or whitelist

69

ip_allow_list_set: configures an IP address whitelist.

ip_list: specifies the IP addresses to be added to the whitelist. Separate multiple IP addresses with commas (,).

Configure an IP address blacklist or whitelist

15

error_page: redirects an error page to a specified page.

error_code: specifies the error code.

rewrite_page: specifies the page to which error pages are redirected when the specified error occurs.

Customize an error page

18

set_req_host_header: configures the custom header for requests that are redirected to the origin server.

domain_name: specifies the custom domain name that is used as the origin host.

Configure an origin host

19

set_hashkey_args: ignores URL parameters.

hashkey_args: specifies the parameters to be reserved. Separate multiple parameters with commas (,). You can specify up to 10 parameters.

disable: A value of on indicates all parameters are ignored. A value of off indicates all parameters are reserved. The hashkey_args setting has a higher priority. Even if you have set this setting to on, the parameters specified in hashkey_args are reserved.

keep_oss_args: specifies whether to reserve all the origin parameters in back-to-origin requests. A value of on indicates that all the origin parameters in back-to-origin requests are reserved. A value of off indicates that only the parameters specified in hashkey_args are reserved.

Configure the parameter filtering feature

25

aliauth: configures Alibaba Cloud authentication.

auth_type: specifies the authentication type. A value of no_auth indicates to disable authentication. A value of type_a indicates to use authentication type A. A value of type_b indicates to use authentication type B. A value of type_c indicates to use authentication type C.

auth_key1: specifies the primary authentication key. auth_key2: specifies the secondary authentication key.

ali_auth_delta: customizes the buffer time for authentication.

Configure URL authentication

27

set_resp_header: sets a response header. To verify the setting, you can check the response in a browser.

key: specifies the response header. This parameter is required.

value: specifies the value of the response header. This parameter is required. Enter null if you need to delete the header.

header_operation_type: specifies the action to be performed on the request header. Valid values: add, delete, modify, and rewrite. The Add action adds a request header. The Delete action deletes a request header. The Modify action modifies a request header. The Rewrite action rewrites a request header.

duplicate: specifies whether to allow duplicate response headers. Valid values: on and off.

header_source: searches for the source of the response header.

header_destination: replaces the response header.

match_all: specifies whether to match all queries. Valid values: on and off.

Customize an HTTP header

44

https_force: redirects visitors from HTTP URLs to HTTPS URLs.

enable: specifies whether to enable the feature. Valid values: on and off.

Configure the force redirect feature

45

http_force: redirects the original requests as HTTP requests.

enable: specifies whether to enable the feature. Valid values: on and off.

Configure the force redirect feature

78

https_option: configures basic parameters of HTTPS.

http2: specifies whether to enable HTTP/2. Valid values: on and off.

ocsp_stapling: specifies whether to enable OCSP Stapling. Valid values: on and off.

Configure an SSL certificate, Enable HTTP/2, Configure OCSP stapling

47

forward_scheme: configures the static origin protocol policy.

enable: specifies whether to enable the feature. Valid values: on and off.

scheme_origin: specifies the protocol policy that is used to communicate with the origin server. Valid values: http, https, and follow.

Configure the static origin protocol policy

46

dynamic: configures the DCDN service.

enable: specifies whether to enable the feature. This parameter is required. Valid values: on and off.

static_route_type: specifies the file name extension for static content.

static_route_url: specifies the URI of the static content.

static_route_path: specifies the path of the static content.

dynamic_route_origin: specifies the protocol policy that is used to communicate with the origin server. Valid values: http, https, follow, and follow-port.

dynamic_route_round_robin: specifies whether to enable load balancing. Valid values: on and off.

dynamic_route_adapt_cache: specifies whether to enable adaptive caching. Valid values: on and off.

Dynamic and static acceleration rules

39

set_req_header: customizes an HTTP header for requests that are redirected to the origin server.

key: specifies the name of the header.

value: specifies the value of the header.

Customize an origin HTTP header

85

l2_oss_key: retrieves content from private OSS buckets.

private_oss_auth: specifies whether to retrieve your content from private OSS buckets. Valid values: on and off.

Enable authorization to access private buckets

31

range: configures object chunking.

enable: specifies whether to enable the feature. Valid values: on and off.

Configure range origin fetch

30

video_seek: configures video seeking.

enable: specifies whether to enable the feature. This parameter is required. Valid values: on and off.

flv_seek_by_time: specifies whether to enable Flash Video (FLV) seeking by time. Valid values: on and off.

mp4_seek_start: customizes MP4 video start parameters.

mp4_seek_end: customizes MP4 video end parameters.

flv_seek_start: customizes FLV video start parameters.

flv_seek_end: customizes FLV video end parameters.

Configure video seeking

144

websocket: configures the WebSocket protocol.

enabled: specifies whether to enable the feature. This parameter is required. Valid values: on and off.

origin_scheme: specifies the protocol policy that is used to communicate with the origin. Valid values: http, https, and follow.

heartbeat: specifies the heartbeat interval. Unit: seconds. Valid values: 1 to 300. Default value: 60.

Configure WebSocket

75

ali_remove_args: deletes URL parameters.

ali_remove_args: specifies the parameters to be deleted. The remaining parameters are used as the URL parameters in the hashkey_args. Separate multiple parameters with spaces. The ali_remove_args parameter is required.

keep_oss_args: specifies whether to reserve back-to-origin parameters. A value of on indicates that all parameters are reserved during the back-to-origin process. A value of off indicates that only the parameters in the hashkey_args are reserved.

Configure the parameter filtering feature

110

https_tls_version: configures the TLS protocol.

tls10: specifies whether to enable TLS 1.0. Valid values: on and off. Default value: on.

tls11: specifies whether to enable TLS 1.1. Valid values: on and off. Default value: on.

tls12: specifies whether to enable TLS 1.2. Valid values: on and off. Default value: on.

tls13: specifies whether to enable TLS 1.3. Valid values: on and off. Default value: off.

Configure TLS

112

HSTS: configures HSTS.

enabled: specifies whether to enable the feature. This parameter is required. Valid values: on and off. Default value: off.

https_hsts_max_age: specifies the validity period of the HSTS policy. This parameter is required. Unit: milliseconds. We recommend that you set the value to 5184000000. This value equals 60 days.

https_hsts_include_subdomains: specifies whether the HSTS header contains the includeSubDomains parameter. Valid values: on and off. Use caution if you want to enable this feature. Make sure that HTTPS is enabled for all the subdomains of the domain name to be accelerated. Otherwise, the subdomains become inaccessible after they are redirected to HTTPS.

Configure TLS

63

filetype_force_ttl_code: configures a time-to-live (TTL) rule for HTTP status codes based on file types.

file_type: specifies the file type. You can specify one or more file types. Separate multiple file types with commas (,). For example, enter TXT,JPG.

code_string: specifies the status codes. This parameter is required. Separate multiple status codes with commas (,). Example: 302=0,301=0,4xx=2.

Create a cache expiration rule for HTTP status codes

65

path_force_ttl_code: configures a TTL rule for HTTP status codes based on directories.

path: specifies the directory. This parameter is required. It must start with a forward slash (/). Example: /image.

code_string: specifies the status codes. This parameter is required. Separate multiple status codes with commas (,). Example: 302=0,301=0,4xx=2.

Create a cache expiration rule for HTTP status codes

35

gzip: configures gzip compression.

enable: specifies whether to enable the feature. This parameter is required. Valid values: on and off.

Configure smart compression

16

tesla: configures page optimization.

enable: specifies whether to enable the feature. This parameter is required. Valid values: on and off.

trim_js: specifies whether to optimize JavaScript content on HTML pages. Valid values: on and off.

trim_css: specifies whether to optimize CSS content on HTML pages. Valid values: on and off.

Configure HTML optimization

114

https_origin_sni: configures an origin Server Name Indication (SNI).

enabled: specifies whether to enable the feature. Valid values: on and off.

https_origin_sni: configures an origin SNI. This parameter is required.

Configure an origin SNI

163

protogw: configures IP address acceleration

realip: specifies the transparent proxy mode for the origin server to obtain the real IP addresses of the clients. This parameter is required. Valid values: off, toa, and pp.

port: specifies the service port. This parameter is required.

patten: specifies the mode string.

IP Application Accelerator

43

host_redirect: configures the rewrite feature.

regex: specifies the URL to be rewritten, for example, ^/$.

replacement: specifies the new URL, for example, /go/act/sale/tbzlsy.php.

flag: Valid values are redirect and break.

Create a URI rewrite rule

124

forward_timeout: configures the timeout period for requests that are redirected to the origin server.

forward_timeout: specifies the time period in seconds. We recommend that you set a value that is not greater than 100.

Configure a timeout period for origin fetch requests

194

ipv6: configures IPv6.

switch: specifies whether to enable the feature. This parameter is required. Valid values: on and off.

region: specifies the region where you want to enable IPv6. You can enter an asterisk (*) to specify all regions.

Configure IPv6

180

edge_function: configures EdgeScript.

rule: specifies DSL-based scripts. This parameter is required.

pri: specifies the priority of the DSL script. This parameter is required.

enable: specifies whether to enable the script. This parameter is required. Valid values: on and off.

name: specifies the name of the script.

pos: specifies whether to execute the script at the start or end of the request processing pipeline. For the accelerated domain names of DCDN, only the value of head is supported. The value of foot is not supported.

brk: after the script is matched, the subsequent scripts at the specified position are skipped.

option: configures an extension used to perform response header debugging.

grammar: an extension used to specify the scripting language. Valid values: es2 and js. You can also leave this parameter empty.

jsmode: an extension used to manage the domain name whitelist in JavaScript. Valid value: redirect and bypass.

EdgeScript

97

brotli: configures Brotli compression.

enable: specifies whether to enable the feature. This parameter is required. Valid values: on and off.

brotli_level: specifies the compression level. Valid values: 1 to 11.

Configure Brotli compression

58

ali_ua: configures a user-agent-based whitelist or blacklist.

ua: specifies user agents.

type: specifies the type of the user agent list. Valid values: black and white.

Configure a User-Agent blacklist or whitelist

Response parameters

Parameter Type Example Description
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

Examples

Sample requests

http(s)://dcdn.aliyuncs.com/?Action=BatchDeleteDcdnDomainConfigs
&DomainNames=example.com
&FunctionNames=referer_white_list_set,https_force
&<Common request parameters>

Sample success responses

XML format

<BatchDeleteDcdnDomainConfigsResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</BatchDeleteDcdnDomainConfigsResponse>

JSON format

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HttpCode Error code Error message Description
400 Invalid%s.ValueNotSupported FunctionName [%s] is not supported. The error message returned because the value specified for the FunctionName parameter is invalid. Specify a valid value.

For a list of error codes, visit the API Error Center.