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

Note 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 software development kits (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 in each call.

FunctionNames String No aliauth

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

The following table describes the features.

Feature

Description

referer_white_list_set

Configures a referer whitelist.

referer_black_list_set

Configures a referer blacklist.

filetype_based_ttl_set

Sets expiration rules for files.

path_based_ttl_set

Sets expiration rules for directories.

oss_auth

Specifies the Object Storage Bucket (OSS) bucket that requires access authentication.

ip_black_list_set

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

ip_allow_list_set

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

ip_white_list_set

Configures a rate limiting list. ip_list: specifies the IP addresses to be added to the rate limiting list. Separate multiple IP addresses with commas (,).

error_page

Redirects requests from an error page to a specified page.

tesla

Configures the HTML optimization feature.

set_req_host_header

Modifies the Host header in requests before they are redirected to the origin server.

set_req_header

Modifies custom headers in requests before they are redirected to the origin server.

set_hashkey_args

Ignores URL parameters.

aliauth

Configures Alibaba authentication.

set_resp_header

Sets a response header. To verify this setting, you can check the response messages in a browser.

video_seek

Configures the video seeking feature.

range

Configures the object chunking feature.

gzip

Configures the Gzip compression feature.

https_force

Redirects requests from HTTP URLs to HTTPS URLs.

http_force

Redirects requests from HTTPS URLs to HTTP URLs.

alilive

Configures the ApsaraVideo Live service.

forward_scheme

Configures the static origin protocol policy.

tmd_signature

Creates a custom rate limiting rule.

cdn_waf

Configures basic WAF protection features.

https_origin_sni

Configures an origin Server Name Indication (SNI).

quic

Sets basic parameters of Quick UDP Internet Connection (QUIC).

forward_timeout

Specifies the timeout period of requests that are redirected to the origin server.

ali_video_split

Configures the audio extraction feature.

ipv6

Configures IPv6 settings.

ali_video_preview

Configures the video preview feature.

default_ttl_code

Specifies a time-to-live (TTL) value for HTTP status codes.

edge_function

Configures EdgeScript functions.

follow_302

Configures 302 redirects.

aws_s3_bucket

Specifies the Amazon Web Services (AWS) Simple Storage Service (S3) buckets that require authentication.

origin_certificate_verification

Verifies certificates of requests before they are redirected to the origin server.

origin_dns_host

Configures an origin host.

cc_defense

Sets the priorities of custom rate limiting rules.

cc_rule

Configures the rate limiting feature.

back_to_origin_argument_rewrite

Rewrites parameters in requests before they are redirected to the origin server.

back_to_origin_url_rewrite

Rewrites URLs in requests before they are redirected to the origin server.

self_defined_cachekey

Configures custom cache keys.

advanced_origin

Configures advanced settings for requests that are redirected to the origin server.

ddos_domain

Configures DDoS mitigation rules.

ali_location

Blocks requests from specified regions.

https_option

Sets the basic parameters of HTTPS. Sets the basic parameters of HTTPS. Valid values:

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.

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 configuration.

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=example.com
&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 FunctionName parameter is set to an invalid value.

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