Call BatchDeleteDcdnDomainConfigs to batch delete domain configurations - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Operation description

Note

The call frequency limit for a single user is 30 requests per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:BatchDeleteDcdnDomainConfigs

update

*domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainNames	string	Yes	The accelerated domain names for which you want to delete configurations. Separate multiple domain names with commas (,). Note the following limits: The product of the number of domain names and the number of functions must be less than or equal to 20. For example: If 20 functions are configured at a time, only 1 domain name can be specified. If 1 function is configured at a time, up to 20 domain names can be specified.	example.com
FunctionNames	string	Yes	The names of the feature functions that you want to delete. Separate multiple function names with commas (,). Note the following limits: The product of the number of domain names and the number of functions must be less than or equal to 20. For example: If 20 functions are configured at a time, only 1 domain name can be specified. If 1 function is configured at a time, up to 20 domain names can be specified. For more information about function names, see Parameters for configuring features for domain names.	referer_white_list_set,https_force

The following table describes the features.

Name	Parameter
referer_white_list_set: Referer whitelist	refer_domain_allow_list: the whitelist. Separate multiple values with commas (,). allow_empty: specifies whether to allow requests with an empty Referer header to access DCDN resources. Valid values: on and off.
referer_black_list_set: Referer blacklist	refer_domain_deny_list: the blacklist. Separate multiple values with commas (,). allow_empty: specifies whether to allow requests with an empty Referer header to access DCDN resources. Valid values: on and off.
filetype_based_ttl_set: file type-based cache expiration	ttl: the cache expiration time. Unit: seconds. file_type: the file type. Separate multiple file types with commas (,), such as TXT,JPG. weight: the weight.
path_based_ttl_set: directory-based cache expiration	ttl: the cache expiration time. Unit: seconds. path: the directory, which must start with a forward slash (/). weight: the weight.
oss_auth: OSS authentication bucket	oss_bucket_id: the address of your bucket.
ip_black_list_set: IP blacklist	ip_list: the IP list. Separate multiple IP addresses with commas (,).
ip_allow_list_set: IP whitelist	ip_list: the IP list. Separate multiple IP addresses with commas (,).
error_page: error page redirect	error_code: the error code. rewrite_page: the redirect page.
set_req_host_header: custom origin host header	domain_name: the content of the origin host header.
set_hashkey_args: ignore URL parameters	hashkey_args: the list of parameters to retain. Separate multiple parameters with commas (,). A maximum of 10 parameters are supported. disable: set to on to ignore all parameters, or off to not ignore parameters. When the cache hashkey ignores all parameters, this setting has a lower priority than the retained parameter list. keep_oss_args: set to on to retain all parameters during origin requests, or off to use the same parameters as the cache hashkey.
aliauth: Alibaba Cloud authentication	auth_type: the authentication type. no_auth: no authentication. type_a: authentication type A. type_b: authentication type B. type_c: authentication type C. auth_key1: authentication key 1. auth_key2: authentication key 2. ali_auth_delta: the custom authentication buffer time.
set_resp_header: HTTP response header (visible on the browser)	key (required): the response header. value (required): the response header content. Set to null to delete the header. header_operation_type: the header operation. Valid values: add, delete, modify, and rewrite. duplicate: specifies whether to allow duplicates. Valid values: on and off. header_source: the search value. header_destination: the replacement value. match_all: specifies whether to match all. Valid values: on and off.
https_force: force HTTPS redirect	enable: the feature switch. Valid values: on and off.
http_force: force HTTP redirect	enable: the feature switch. Valid values: on and off.
https_option: HTTPS basic parameters	http2: the HTTP/2 switch. Valid values: on and off. ocsp_stapling: the OCSP Stapling switch. Valid values: on and off.
forward_scheme: static origin protocol	enable: the switch. Valid values: on and off. scheme_origin: the origin protocol type. Valid values: http, https, and follow.
dynamic: DCDN-related configurations	enable (required): the switch. Valid values: on and off. static_route_type: the file extension for static acceleration. static_route_url: the URI for static acceleration. static_route_path: the path for static acceleration. dynamic_route_origin: the origin routing scheme. Valid values: http, https, follow, and follow-port. dynamic_route_round_robin: the load balancing switch. Valid values: on and off. dynamic_route_adapt_cache: the adaptive caching switch. Valid values: on and off.
set_req_header: custom origin HTTP header	key: the origin header. value: the origin header content.
l2_oss_key: Alibaba Cloud OSS private bucket origin	private_oss_auth: the private bucket origin switch. Valid values: on and off.
range: range-based origin	enable: the switch. Valid values: on and off.
video_seek: video seeking	enable (required): the switch. Valid values: on and off. flv_seek_by_time: enables FLV time-based seeking. Valid values: on and off. mp4_seek_start: the custom MP4 start parameter. mp4_seek_end: the custom MP4 end parameter. flv_seek_start: the custom FLV start parameter. flv_seek_end: the custom FLV end parameter.
websocket: WebSocket	enabled (required): specifies whether to enable the feature. Valid values: on and off. origin_scheme: the origin scheme. Valid values: http, https, and follow. heartbeat: the heartbeat time. Default value: 60. Unit: seconds. Valid values: 1 to 300.
ali_remove_args: ignore specific parameter	ali_remove_args (required): the parameters to delete. Separate multiple parameters with spaces. The remaining parameters are used as the URL args part of the hashkey. keep_oss_args: specifies whether to retain parameters during origin requests. Valid values: on and off. on indicates that all parameters are retained during origin requests. off indicates that the parameters are consistent with the cache hashkey.
https_tls_version: TLS protocol version	tls10: enables TLSv1.0. Default value: on. Valid values: on and off. tls11: enables TLSv1.1. Default value: on. Valid values: on and off. tls12: enables TLSv1.2. Default value: on. Valid values: on and off. tls13: enables TLSv1.3. Default value: off. Valid values: on and off.
HSTS: HSTS	enabled (required): the switch. Default value: off. Valid values: on and off. https_hsts_max_age (required): the expiration time. Unit: ms. We recommend that you set this parameter to 5184000000 ms (60 days). https_hsts_include_subdomains: specifies whether the HSTS header contains the includeSubDomains parameter. Valid values: on and off. Exercise caution when you enable this feature. Before you enable this feature, make sure that HTTPS is enabled for all subdomains of the accelerated domain name. Otherwise, the subdomains become inaccessible after they are automatically redirected to HTTPS.
filetype_force_ttl_code: file type-based status code expiration	file_type (required): the file type. Separate multiple file types with commas (,), such as TXT,JPG. code_string (required): the status code. Separate multiple status codes with commas (,), such as 302=0,301=0,4xx=2.
path_force_ttl_code: path-based status code expiration	path (required): the path, which must start with a forward slash (/), such as /image. code_string (required): the status code. Separate multiple status codes with commas (,), such as 302=0,301=0,4xx=2.
gzip: intelligent compression	enable (required): the feature switch. Valid values: on and off.
tesla: page optimization	enable (required): the feature switch. Valid values: on and off. trim_js: Valid values: on and off. If this feature is enabled, the JavaScript code embedded in HTML is optimized. trim_css: Valid values: on and off. If this feature is enabled, the CSS code embedded in HTML is optimized.
https_origin_sni: origin SNI	enabled: the feature switch. Valid values: on and off. https_origin_sni (required): the origin SNI.
protogw: IP application acceleration	realip (required): the method for passing through the real IP address of the origin. Valid values: off, toa, and pp. port (required): the service port. patten: the pattern string.
host_redirect: rewrite	regex: the URL to rewrite, such as ^/$. replacement: the target URL, such as /go/act/sale/tbzlsy.php. flag: only redirect and break are supported.
forward_timeout: origin request timeout	forward_timeout: the timeout period. Unit: seconds. Set this parameter to a value no greater than 100 seconds.
ipv6: IPv6 configuration	switch (required): the switch. Valid values: on and off. on indicates that IPv6 is enabled. off indicates that IPv6 is disabled. region: the region in which IPv6 is enabled. An asterisk (*) is supported.
edge_function: edge function	rule (required): the DSL rule. pri (required): the priority. enable (required): specifies whether the rule takes effect. Valid values: on and off. name: the rule name. pos: the rule execution position. DCDN domain names support only head, not foot. brk: specifies that after this rule is matched, the remaining rules at the current execution position are skipped. option: the option control. grammar: the grammar control. Valid values: empty, es2, and js. jsmode: the JavaScript domain name whitelist control. Valid values: redirect and bypass.
brotli: Brotli compression	enable (required): the feature switch. Valid values: on and off. brotli_level: the compression level. Valid values: 1 to 11.
ali_ua: User-Agent blacklist/whitelist	ua: the User-Agent. type: the list type. Valid values: black and white.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.	The specified configuration is not supported.
400	DeleteFunctionFailed	Batch delete functions failed.	Failed to delete the configurations.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.