Queries the configurations of an accelerated domain name.

You can query multiple feature configurations at a time in each call.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDcdnDomainConfigs

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

DomainName String Yes example.com

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

FunctionNames String Yes filetype_based_ttl_set,set_req_host_header

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

Features

Name

Description

referer_white_list_set

Configures the referer whitelist.

referer_black_list_set

Configures the referer blacklist.

filetype_based_ttl_set

Sets the expiration rules for files.

path_based_ttl_set

Sets the expiration rules for directories.

cc_defense

Configures protection against HTTP flood attacks.

oss_auth

Controls the access to an Object Storage Service (OSS) bucket.

ip_black_list_set

Configures the IP address blacklist.

ip_white_list_set

Configures the IP address whitelist.

error_page

Redirects an error page to a specified page.

tesla

Configures HTML optimization for content delivery acceleration.

set_req_host_header

Modifies the origin host.

set_req_header

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

set_hashkey_args

Filters URL parameters.

aliauth

Configures the Alibaba Cloud authentication.

set_resp_header

Sets the 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 intelligent compression with GNU zip.

https_force

Forces redirection of HTTP requests to HTTPS.

http_force

Forces redirection of HTTPS requests to HTTP.

alilive

Configures the ApsaraVideo Live service.

forward_scheme

Configures the static origin protocol policy.

dynamic

Dynamic Route for CDN.

tmd_signature

Specifies a custom rule for rate limiting.

websocket

Configures WebSocket-based features.

quic

Configures Quick UDP Internet Connection (QUIC).

forward_timeout

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

https_option

Specifies the basic parameters of HTTPS. Valid values:

http2: specifies whether to enable HTTP/2 support. Valid values: on and off.

ocsp_stapling: specifies whether to enable Online Certificate Status Protocol (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 5068995

The ID of the configuration.

FunctionArgs Array of FunctionArg

The feature configurations returned.

FunctionArg
ArgName String ttl

The name of the configuration.

ArgValue String 13

The value of the configuration.

FunctionName String set_req_host_header

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 being tested.
  • failed: The configuration failed.
  • configuring: The configuration is being applied.
RequestId String F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED

The ID of the request.

Examples

Sample requests

http://dcdn.aliyuncs.com?Action=DescribeDcdnDomainConfigs
&DomainName=example.com
&FunctionNames=filetype_based_ttl_set,set_req_host_header
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnDomainConfigsResponse>
      <RequestId>F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED</RequestId>
      <DomainConfigs>
            <DomainConfig>
                  <FunctionArgs>
                        <FunctionArg>
                              <ArgName>domain_name</ArgName>
                              <ArgValue>testdcdn3.cdnpe.com</ArgValue>
                        </FunctionArg>
                  </FunctionArgs>
                  <ConfigId>5003576</ConfigId>
                  <FunctionName>set_req_host_header</FunctionName>
            </DomainConfig>
            <DomainConfig>
                  <FunctionArgs>
                        <FunctionArg>
                              <ArgName>file_type</ArgName>
                              <ArgValue>txt</ArgValue>
                        </FunctionArg>
                        <FunctionArg>
                              <ArgName>ttl</ArgName>
                              <ArgValue>13</ArgValue>
                        </FunctionArg>
                  </FunctionArgs>
                  <ConfigId>5068995</ConfigId>
                  <FunctionName>filetype_based_ttl_set</FunctionName>
            </DomainConfig>
      </DomainConfigs>
</DescribeDcdnDomainConfigsResponse>

JSON format

{
  "RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "domain_name",
              "ArgValue": "testdcdn3.cdnpe.com"
            }
          ]
        },
        "ConfigId": 5003576,
        "FunctionName": "set_req_host_header"
      },
      {
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "file_type",
              "ArgValue": "txt"
            },
            {
              "ArgName": "ttl",
              "ArgValue": "13"
            }
          ]
        },
        "ConfigId": 5068995,
        "FunctionName": "filetype_based_ttl_set"
      }
    ]
  }
}

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 not supported.

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