You can call this operation to query configurations of one or more accelerated domains.

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 name of the accelerated domain for which you want to query configurations. You can specify multiple 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

Feature

Description

referer_white_list_set

Configures a referer whitelist.

referer_black_list_set

Configures a referer blacklist.

filetype_based_ttl_set

Sets a file expiration rule.

path_based_ttl_set

Sets a directory expiration rule.

cc_defense

Configures protection against HTTP flood attacks.

oss_auth

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

ip_black_list_set

Configures an IP blacklist.

ip_white_list_set

Configures an IP whitelist.

error_page

Customizes an error page.

tesla

Configures HTML optimization for website acceleration.

set_req_host_header

Modifies the custom origin host.

set_hashkey_args

Ignores URL parameters.

aliauth

Configures URL authentication.

set_resp_header

Sets a response header. To verify the setting, you can check the response messages on the client (browser).

video_seek

Configures the video seeking feature.

range

Configures the object chunking feature to retrieve content from the origin based on HTTP range requests.

gzip

Configures intelligent compression with GNU zip (Gzip).

https_force

Configures force redirect to HTTPS.

http_force

Configures force redirect to HTTP.

alilive

Configures the ApsaraVideo Live service.

forward_scheme

Configures the static origin protocol policy.

dynamic

Configures the Dynamic Route for CDN service.

tmd_signature

Sets a Taobao Missile Defense (TMD) rule.

websocket

Configures the WebSocket protocol.

Response parameters

Parameter Type Example Description
DomainConfigs Array

The domain configurations returned.

DomainConfig

The configurations of the accelerated domain.

ConfigId String 5003576

The ID of the configuration.

FunctionArgs Array

The parameter settings of the feature.

FunctionArg

In XML format, this parameter indicates the settings of a specific parameter of the feature. In JSON format, this parameter indicates the settings of all parameters of the feature.

ArgName String file_type

The key 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
  • testing
  • failed
  • configuring
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>
				        <FunctionArg>
					          <ArgName>weight</ArgName>
					          <ArgValue>8</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"
						}
					]
				},
				"FunctionName":"set_req_host_header",
				"ConfigId":5003576
			},
			{
				"FunctionArgs":{
					"FunctionArg":[
						{
							"ArgName":"file_type",
							"ArgValue":"txt"
						},
						{
							"ArgName":"ttl",
							"ArgValue":"13"
						},
						{
							"ArgName":"weight",
							"ArgValue":"8"
						}
					]
				},
				"FunctionName":"filetype_based_ttl_set",
				"ConfigId":5068995
			}
		]
	}
}

Error codes

HTTP status code Error code Error message Description
400 Invalid%s.ValueNotSupported FunctionName [%s] is not supported. The error message returned because the specified feature is not supported.

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