Call BatchDeleteDcdnDomainConfigs to batch delete domain configurations - Edge Security Acceleration

Operation description

Note

You can delete a maximum of 50 configurations (domains × functions) per request.
You can make up to 30 calls 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 to delete configurations. Separate multiple domain names with commas (,). You can specify up to 20 domain names per request. The number of domain names multiplied by the number of function names cannot exceed 50.	example.com
FunctionNames	string	Yes	The names of the functions to delete. Separate multiple function names with commas (,). You can specify up to 50 function names per request. For more information, see Domain configuration function parameters.	referer_white_list_set,https_force

The following table lists the available functions.

Name	Parameters
`referer_white_list_set`: Referer allowlist	`refer_domain_allow_list`: The allowlist. Separate multiple domain names with commas (,). `allow_empty`: Specifies whether to allow access to Dynamic Content Delivery Network (DCDN) resources if the Referer header is empty. Valid values: `on` and `off`.
`referer_black_list_set`: Referer blocklist	`refer_domain_deny_list`: The blocklist. Separate multiple domain names with commas (,). `allow_empty`: Specifies whether to allow access to DCDN resources if the Referer header is empty. Valid values: `on` and `off`.
`filetype_based_ttl_set`: File type-based TTL	`ttl`: The time to live (TTL) in seconds. `file_type`: The file types. Separate multiple file types with commas (,). Example: `TXT,JPG`. `weight`: The weight.
`path_based_ttl_set`: Path-based TTL	`ttl`: The TTL in seconds. `path`: The path, 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 blocklist	`ip_list`: The list of IP addresses. Separate multiple IP addresses with commas (,).
`ip_allow_list_set`: IP allowlist	`ip_list`: The list of IP addresses. 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`: Modify 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 (,). You can specify up to 10 parameters. `disable`: Set to `on` to ignore all parameters, or `off` to not ignore them. Ignoring all parameters in the cache hash key has a lower priority than the list of parameters to retain. `keep_oss_args`: Set to `on` to retain all parameters for origin requests, or `off` to use the same parameters as the cache hash key.
`aliauth`: AliAuth	`auth_type`: The authentication type. `no_auth`: No authentication. `type_a`: Authentication method A. `type_b`: Authentication method B. `type_c`: Authentication method C. `auth_key1`: The primary authentication key. `auth_key2`: The secondary authentication key. `ali_auth_delta`: The custom authentication buffer time.
`set_resp_header`: Set HTTP response header	`key` (Required): The response header. `value` (Required): The value of the response header. To delete a header, specify `null`. `header_operation_type`: The header operation type. Valid values: `add`, `delete`, `modify`, and `rewrite`. `duplicate`: Specifies whether to allow duplicate headers. Valid values: `on` and `off`. `header_source`: The source to find. `header_destination`: The replacement. `match_all`: Specifies whether to match all instances. Valid values: `on` and `off`.
`https_force`: Force HTTPS redirect	`enable`: Specifies whether to enable the function. Valid values: `on` and `off`.
`http_force`: Force HTTP redirect	`enable`: Specifies whether to enable the function. Valid values: `on` and `off`.
`https_option`: HTTPS basic parameters	`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`.
`forward_scheme`: Static protocol follows origin	`enable`: Specifies whether to enable the function. Valid values: `on` and `off`. `scheme_origin`: The origin protocol type. Valid values: `http`, `https`, and `follow`.
`dynamic`: Dynamic content acceleration	`enable` (Required): Specifies whether to enable the function. Valid values: `on` and `off`. `static_route_type`: The file extensions for static acceleration. `static_route_url`: The URI for static acceleration. `static_route_path`: The path for static acceleration. `dynamic_route_origin`: The origin route scheme. 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`.
`set_req_header`: Set custom origin HTTP header	`key`: The origin header. `value`: The value of the origin header.
`l2_oss_key`: Alibaba Cloud OSS private bucket origin	`private_oss_auth`: Specifies whether to enable origin requests to a private OSS bucket. Valid values: `on` and `off`.
`range`: Range origin	`enable`: Specifies whether to enable the function. Valid values: `on` and `off`.
`video_seek`: Video seek	`enable` (Required): Specifies whether to enable the function. Valid values: `on` and `off`. `flv_seek_by_time`: Enables seeking by time for FLV files. Valid values: `on` and `off`. `mp4_seek_start`: The custom start parameter for MP4 seeking. `mp4_seek_end`: The custom end parameter for MP4 seeking. `flv_seek_start`: The custom start parameter for FLV seeking. `flv_seek_end`: The custom end parameter for FLV seeking.
`websocket`: WebSocket	`enabled` (Required): Specifies whether to enable the function. Valid values: `on` and `off`. `origin_scheme`: The origin scheme. Valid values: `http`, `https`, and `follow`. `heartbeat`: The heartbeat interval. Default: 60 seconds. Range: 1 to 300 seconds.
`ali_remove_args`: Ignore URL parameters (remove)	`ali_remove_args` (Required): The parameters to remove. Separate multiple parameters with spaces. The remaining parameters form the URL arguments part of the hash key. `keep_oss_args`: Specifies whether to retain parameters for origin requests. Set to `on` to retain all parameters, or `off` to use the same parameters as the cache hash key.
`https_tls_version`: TLS protocol version	`tls10`: Specifies whether to enable TLSv1.0. Default: `on`. Valid values: `on` and `off`. `tls11`: Specifies whether to enable TLSv1.1. Default: `on`. Valid values: `on` and `off`. `tls12`: Specifies whether to enable TLSv1.2. Default: `on`. Valid values: `on` and `off`. `tls13`: Specifies whether to enable TLSv1.3. Default: `off`. Valid values: `on` and `off`.
`HSTS`: HSTS	`enabled` (Required): Specifies whether to enable the function. Default: `off`. Valid values: `on` and `off`. `https_hsts_max_age` (Required): The expiration time in milliseconds. We recommend that you set this to `5184000000` (60 days). `https_hsts_include_subdomains`: Specifies whether to include the `includeSubDomains` directive in the HSTS header. Valid values: `on` and `off`. Use this parameter with caution. Before enabling it, ensure all subdomains of the accelerated domain support HTTPS. Otherwise, these subdomains may become inaccessible.
`filetype_force_ttl_code`: Status code-based TTL for file types	`file_type` (Required): The file types. Separate multiple types with commas (,). Example: `TXT,JPG`. `code_string` (Required): The status codes. Separate multiple codes with commas (,). Example: `302=0,301=0,4xx=2`.
`path_force_ttl_code`: Status code-based TTL for paths	`path` (Required): The path, which must start with a forward slash (/). Example: `/image`. `code_string` (Required): The status codes. Separate multiple codes with commas (,). Example: `302=0,301=0,4xx=2`.
`gzip`: Gzip compression	`enable` (Required): Specifies whether to enable the function. Valid values: `on` and `off`.
`tesla`: HTML optimization	`enable` (Required): Specifies whether to enable the function. Valid values: `on` and `off`. `trim_js`: Specifies whether to optimize inline JavaScript code in HTML. Valid values: `on` and `off`. `trim_css`: Specifies whether to optimize inline CSS code in HTML. Valid values: `on` and `off`.
`https_origin_sni`: Origin SNI	`enabled`: Specifies whether to enable the function. Valid values: `on` and `off`. `https_origin_sni` (Required): The origin SNI.
`protogw`: IP application acceleration	`realip` (Required): The method for passing the real IP address of the client. Valid values: `off`, `toa`, and `pp`. `port` (Required): The service port. `patten`: The pattern string.
`host_redirect`: Rewrite	`regex`: The URL to rewrite. Example: `^/$`. `replacement`: The destination URL. Example: `/go/act/sale/tbzlsy.php`. `flag`: The `redirect` and `break` flags are supported.
`forward_timeout`: Origin request timeout	`forward_timeout`: The timeout period in seconds. We recommend that you do not set this to a value greater than 100.
`ipv6`: IPv6 configuration	`switch` (Required): Specifies whether to enable the feature. Valid values: `on` and `off`. `region`: The regions where IPv6 is enabled. An asterisk (*) is supported.
`edge_function`: Edge Routine	`rule` (Required): The DSL rule. `pri` (Required): The priority. `enable` (Required): Specifies whether the rule is effective. Valid values: `on` or `off`. `name`: The rule name. `pos`: The execution position of the rule. For DCDN domains, only `head` is supported. `brk`: If 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 allowlist control. Valid values: `redirect` and `bypass`.
`brotli`: Brotli compression	`enable` (Required): Specifies whether to enable the function. Valid values: `on` and `off`. `brotli_level`: The compression level. Valid values: 1 to 11.
`ali_ua`: User-Agent blocklist/allowlist	`ua`: The User-Agent. `type`: The list type. Valid values: `black` and `white`.

Response elements

Element	Type	Description	Example
	object	The response parameters.
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.