DescribeDcdnDomainConfigs - Edge Security Acceleration - Alibaba Cloud Documentation Center

Operation description

Note

You can query the configurations of multiple features in a single request.
The request rate limit for a single user is 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:DescribeDcdnDomainConfigs

get

domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can query only one domain name at a time.	example.com
FunctionNames	string	No	The names of the features. Separate multiple feature names with commas (,).	filetype_based_ttl_set,set_req_host_header
ConfigId	string	No	The configuration ID.	5003576

The following table describes the features.

Name	Parameters
referer_white_list_set: Referer hotlink protection whitelist	refer_domain_allow_list: The whitelist. Separate multiple domain names 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 hotlink protection blacklist	refer_domain_deny_list: The blacklist. Separate multiple domain names 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: Configure time-to-live (TTL) based on file type	ttl: The cache duration. Unit: seconds. file_type: The file type. Separate multiple file types with commas (,), for example, TXT,JPG. weight: The weight.
path_based_ttl_set: Configure TTL based on path	ttl: The cache duration. Unit: seconds. path: The path. The path must start with a forward slash (/). weight: The weight.
oss_auth: OSS authentication for buckets	oss_bucket_id: The URL of your bucket.
ip_black_list_set: IP address blacklist	ip_list: The list of IP addresses. Separate multiple IP addresses with commas (,).
ip_allow_list_set: IP address whitelist	ip_list: The list of IP addresses. Separate multiple IP addresses with commas (,).
error_page: Error page redirection	error_code: The error code. rewrite_page: The redirection page.
set_req_host_header: Modify the custom back-to-origin Host header	domain_name: The content of the back-to-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 key has a lower priority than retaining specific parameters. keep_oss_args: Set to on to retain all parameters for back-to-origin requests, or off to use the same parameters as the cache key.
aliauth: Alibaba Cloud authentication	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: Authentication key 1. auth_key2: Authentication key 2. ali_auth_delta: The custom authentication grace period.
set_resp_header: Set HTTP response headers (visible to browsers)	key (Required): The response header. value (Required): The content of the response header. To delete the header, set this to null. header_operation_type: The operation on the request header. Valid values: add, delete, modify, and rewrite. duplicate: Specifies whether to allow duplicates. Valid values: on or off. header_source: The header to find. header_destination: The header to replace with. match_all: Specifies whether to match all. Valid values: on or off.
https_force: Force HTTPS redirection	enable: The switch for the feature. Valid values: on or off.
http_force: Force HTTP redirection	enable: The switch for the feature. Valid values: on or off.
https_option: Basic HTTPS parameters	http2: The HTTP/2 switch. Valid values: on or off. ocsp_stapling: The Online Certificate Status Protocol (OCSP) Stapling switch. Valid values: on or off.
forward_scheme: Follow protocol for back-to-origin requests	enable: The switch. Valid values: on or off. scheme_origin: The protocol for back-to-origin requests. Valid values: http, https, and follow.
dynamic: DCDN-related configurations	enable (Required): The switch. Valid values: on or 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 scheme for the back-to-origin route. Valid values: http, https, follow, and follow-port. dynamic_route_round_robin: The switch for load balancing. Valid values: on or off. dynamic_route_adapt_cache: The switch for adaptive caching. Valid values: on or off.
set_req_header: Custom back-to-origin HTTP headers	key: The back-to-origin header. value: The content of the back-to-origin header.
l2_oss_key: Back-to-origin requests to private Alibaba Cloud OSS buckets	private_oss_auth: The switch for back-to-origin requests to private buckets. Valid values: on or off.
range: Range-based back-to-origin requests	enable: The switch. Valid values: on and off.
video_seek: Video seeking	enable (Required): The switch. Valid values: on or off. flv_seek_by_time: Enables seeking by time for FLV files. Valid values: on or 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 WebSocket. Valid values: on or off. origin_scheme: The scheme for back-to-origin requests. Valid values: http, https, and follow. heartbeat: The heartbeat interval. Default value: 60. Unit: seconds. Valid values: 1 to 300.
ali_remove_args: Ignore URL parameters (delete)	ali_remove_args (Required): The parameters to delete. Separate multiple parameters with spaces. The remaining parameters are used as the URL arguments in the cache key. keep_oss_args: Specifies whether to retain parameters for back-to-origin requests. Valid values: on and off. on indicates that all parameters are retained. off indicates that the parameters are the same as those in the cache key.
https_tls_version: TLS protocol versions	tls10: Enables TLSv1.0. Default value: on. Valid values: on or off. tls11: Enables TLSv1.1. Default value: on. Valid values: on or off. tls12: Enables TLSv1.2. Default value: on. Valid values: on or off. tls13: Enables TLSv1.3. Default value: off. Valid values: on or off.
HSTS: HTTP Strict Transport Security (HSTS)	enabled (Required): The switch. Default value: off. Valid values: on or off. https_hsts_max_age (Required): The expiration time. Unit: ms. A value of 5184000000 ms (60 days) is recommended. https_hsts_include_subdomains: Specifies whether the HSTS header includes the includeSubDomains parameter. Valid values: on or off. Enable this feature with caution. Before you enable it, make sure that HTTPS is enabled for all subdomains of the accelerated domain name. Otherwise, the subdomains become inaccessible after they are redirected to HTTPS.
filetype_force_ttl_code: Expiration time of status codes for file types	file_type (Required): The file type. Separate multiple file types with commas (,), for example, TXT,JPG. code_string (Required): The status code. Separate multiple status codes with commas (,). For example: 302=0,301=0,4xx=2.
path_force_ttl_code: Expiration time of status codes for paths	path (Required): The path must start with a forward slash (/), for example, /image. code_string (Required): The status code. Separate multiple status codes with commas (,). For example: 302=0,301=0,4xx=2.
gzip: Intelligent compression	enable (Required): The switch for the feature. Valid values: on or off.
tesla: HTML optimization	enable (Required): The switch for the feature. Valid values: on or off. trim_js: Valid values: on or off. If you enable this feature, the embedded JavaScript code in HTML pages is optimized. trim_css: Valid values: on or off. If you enable this feature, the embedded CSS code in HTML pages is optimized.
https_origin_sni: Back-to-origin SNI	enabled: The switch for the feature. Valid values: on or off. https_origin_sni (Required): The back-to-origin SNI.
protogw: IP application acceleration	realip (Required): The method to pass through the origin IP address. Valid values: off, toa, and pp. port (Required): The service port. pattern: The pattern string.
host_redirect: Rewrite feature	regex: The URL to rewrite. For example: ^/$. replacement: The destination URL. For example: /go/act/sale/tbzlsy.php. flag: Only redirect and break are supported.
forward_timeout: Timeout period for back-to-origin requests	forward_timeout: The timeout period. Unit: seconds. Do not set this to a value greater than 100 seconds.
ipv6: IPv6 configuration	switch (Required): The switch. Valid values: on (enables IPv6) and off (disables IPv6). region: The region where IPv6 is enabled. The asterisk (*) is supported.
edge_function: EdgeScript	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 position where the rule is executed. For DCDN domain names, only head is supported. foot is not supported. brk: If this rule is hit, the remaining rules at the current execution position are skipped. option: Option control. grammar: Grammar control. Optional values: empty, es2, and js. jsmode: JS domain name whitelist control. Optional values: redirect and bypass.
brotli: Brotli compression	enable (Required): The switch for the feature. Valid values: on or 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 or white.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED
DomainConfigs	object
DomainConfig	array<object>	The domain name configurations.
	object
Status	string	The status. Valid values: success: The operation was successful. testing: The feature is being tested. failed: The operation failed. configuring: The feature is being configured.	success
ParentId	string	The ID of the advanced condition configuration.	1234567
ConfigId	string	The configuration ID.	5068995
FunctionName	string	The feature name.	set_req_host_header
FunctionArgs	object
FunctionArg	array<object>	The feature configuration.
	object
ArgName	string	The configuration name.	ttl
ArgValue	string	The configuration value.	13

Examples

Success response

JSON format

{
  "RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ParentId": "1234567",
        "ConfigId": "5068995",
        "FunctionName": "set_req_host_header",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "ttl",
              "ArgValue": "13"
            }
          ]
        }
      }
    ]
  }
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.