Queries configurations for one or more specified accelerated domains. You can query the configurations of one or more features at a time.

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 DescribeDcdnIpaDomainConfigs

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

DomainName String Yes www.xxx.org.cn

The accelerated domain name for which you want to query data. You can specify multiple accelerated domain names and separate them with commas (,).

FunctionNames String Yes filetype_based_ttl_set,set_req_host_header

The names of the features to query. You can specify multiple features and separate them with commas (,).

Feature description

Parameter

Description

referer_white_list_set

Specifies the referer whitelist.

referer_black_list_set

Specifies the referer blacklist.

filetype_based_ttl_set

Specifies an expiration rule for files.

path_based_ttl_set

Specifies an expiration rule for directories.

cc_defense

Configures protection against HTTP flood attacks.

oss_auth

Authenticates the access to Object Storage Service (OSS) buckets.

ip_black_list_set

Specifies the IP address blacklist.

ip_allow_list_set

Specifies the IP address whitelist.

error_page

Redirects an error page to a specified page.

tesla

Configures page optimization to accelerate accesses.

set_req_host_header

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

set_hashkey_args

Ignores URL parameters.

aliauth

Configures Alibaba authentication.

set_resp_header

Specifies a response header. To verify the setting, you can check the response messages on the client through the browser.

video_seek

Configures video seeking.

range

Configures object chunking.

gzip

Configures HTML optimization.

https_force

Redirects the original requests from a client to L1 as HTTPS requests.

http_force

Redirects the original requests from a client to L1 as HTTP requests.

alilive

Configures the ApsaraVideo Live service.

forward_scheme

Configures the static origin protocol policy.

dynamic

Configures the Dynamic Route for CDN (DCDN) service.

tmd_signature

Specifies Taobao Missile Defense (TMD) rules.

websocket

websocket

Response parameters

Parameter Type Example Description
DomainConfigs Array of DomainConfig

The domain configurations returned.

DomainConfig
ConfigId String 5003576

The ID of the configuration.

FunctionArgs Array of FunctionArg

The parameter settings of the feature.

FunctionArg
ArgName String file_type

The name of the parameter.

ArgValue String txt

The value of the parameter.

FunctionName String set_req_host_header

The name of the feature.

Status String success

The status of the feature. Valid values:

  • success: The configuration is successful.
  • testing: The configuration is under testing.
  • failed: The configuration failed.
  • configuring: The feature is being configured.
RequestId String F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED

The ID of the request.

Examples

Sample requests

http://dcdn.aliyuncs.com?Action=DescribeDcdnIpaDomainConfigs
&DomainName=www.xxx.org.cn
&FunctionNames=filetype_based_ttl_set,set_req_host_header
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnIpaDomainConfigsResponse>
      <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>
</DescribeDcdnIpaDomainConfigsResponse>

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 FunctionName parameter is not supported.

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