Queries the configurations of an accelerated domain name. You can query the configuration of one or more features at a time.

The maximum number of times that each user can call this operation per second is 100.

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 DescribeCdnDomainConfigs

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

DomainName String Yes example.com

The accelerated domain name. You can specify only one domain name.

FunctionNames String No aliauth

The names of the features to query. Separate multiple features with commas (,).

The following table lists the features and their descriptions.

Feature

Description

referer_white_list_set

Configures a referer whitelist

referer_black_list_set

Configures a referer blacklist

filetype_based_ttl_set

Sets an expiration rule for files.

path_based_ttl_set

Sets an expiration rule for directories.

cc_defense

Configures protection against HTTP flood attacks.

oss_auth

Specifies the bucket that requires OSS authentication.

ip_black_list_set

Configures an IP blacklist.

ip_allow_list_set

Configures an IP whitelist.

error_page

Redirects an error page to a specified page.

tesla

Configures page optimization to accelerate access.

set_req_host_header

Modifies the origin host header.

set_req_header

Modifies the custom header of back-to-origin requests.

set_hashkey_args

Ignores URL parameters.

aliauth

Configures Alibaba authentication.

set_resp_header

Configures a response header. To verify the setting, you can check the response message in a browser.

video_seek

Configures video seeking.

range

Configures object chunking.

gzip

Optimizes pages using GNU zip (Gzip) compression.

https_force

Redirects visitors from HTTP URLs to HTTPS URLs.

http_force

Redirects visitors from HTTPS URLs to HTTP URLs.

alilive

Configures the ApsaraVideo Live service.

forward_scheme

Configures the static origin protocol policy.

cdn_waf

Configures basic WAF protection features.

https_origin_sni

Configures an origin SNI.

quic

Configures Quick UDP Internet Connection (QUIC).

forward_timeout

Specifies the timeout period of back-to-origin requests.

ali_video_split

Configures audio extraction.

ipv6

Configures IPv6 settings.

ali_video_preview

Configures the video preview feature.

default_ttl_code

Specifies the time period after which cached data expires based on status codes.

ali_ua

Configures access control based on the user-agent header.

Response parameters

Parameter Type Example Description
DomainConfigs Array of DomainConfig

The configurations of the accelerated domain name.

DomainConfig
ConfigId String 6295

The ID of the configuration.

FunctionArgs Array of FunctionArg

The description of each feature.

FunctionArg
ArgName String auth_type

The key of the parameter.

ArgValue String req_auth

The value of the parameter.

FunctionName String aliauth

The name of the feature.

Status String success

The status of the configuration. Valid values:

  • success: The configuration has been applied.
  • testing: The configuration is under testing.
  • failed: The configuration failed.
  • configuring: The feature is being configured.
RequestId String C80705BF-0F76-41FA-BAD1-5B59296A4E59

The ID of the request.

Examples

Sample requests

http://cdn.aliyuncs.com/?Action=DescribeCdnDomainConfigs
&DomainName=www.xxx.org.cn
&FunctionNames=aliauth
&<Common request parameters>

Sample success responses

XML format

<DescribeCdnDomainConfigsResponse>
	  <RequestId>C80705BF-0F76-41FA-BAD1-5B59296A4E59</RequestId>
	  <DomainConfigs>
		    <DomainConfig>
			      <Status>success</Status>
			      <FunctionArgs>
				        <FunctionArg>
					          <ArgName>auth_type</ArgName>
					          <ArgValue>req_auth</ArgValue>
				        </FunctionArg>
				        <FunctionArg>
					          <ArgName>ali_auth_dual</ArgName>
					          <ArgValue>on</ArgValue>
				        </FunctionArg>
			      </FunctionArgs>
			      <ConfigId>6295</ConfigId>
			      <FunctionName>aliauth</FunctionName>
		    </DomainConfig>
	  </DomainConfigs>
</DescribeCdnDomainConfigsResponse>

JSON format

{
    "RequestId": "C80705BF-0F76-41FA-BAD1-5B59296A4E59",
    "DomainConfigs": {
        "DomainConfig": [
            {
                "Status": "success",
                "FunctionArgs": {
                    "FunctionArg": [
                        {
                            "ArgName": "auth_type",
                            "ArgValue": "req_auth"
                        },
                        {
                            "ArgName": "ali_auth_dual",
                            "ArgValue": "on"
                        }
                    ]
                },
                "ConfigId": 6295,
                "FunctionName": "aliauth"
            }
        ]
    }
}

Error codes

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

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