DescribeDomainConfigs

Last Updated: Apr 16, 2018

Description

Obtain the configuration of the specified CDN domain name.

Request parameters

Parameters Type Required Example values Description
Action String Yes DescribeDomainConfigs

The name of this interface. Value: DescribeDomainConfigs

DomainName String Yes test.test.com

CDN domain name to be accessed.

ConfigList String No cache_expired

Configurations to be queried, separated by commas (half width).
Currently, cache_expired, cc, error_page, http_header, optimize, page_compress, ignore_query_string, range, referer, req_auth, src_host, video_seek, waf, notify_url, and redirect_type configurations can be queried.
If this parameter is left blank, the system queries all configurations.

Return parameters

Parameters Type Example values Description
RequestId String 67E027D8-7A58-4599-B17A-63E9A54FC54F

The request ID.

DomainConfigs

The corresponding configuration data.

  └CacheExpiredConfigs

File and path expiration configuration.

    └ConfigId String 604991

Configuration ID.

    └CacheType String suffix

Suffix/path.

    └CacheContent String jpeg

File type/path.

    └TTL String 1000

Cache time.
Unit: seconds.

    └Weight String 1

SeqID.

    └Status String success

Configuration status.

  └HttpErrorPageConfigs

Error page redirection.

    └ConfigId String 23

Configuration ID.

    └ErrorCode String 501

Error code.

    └PageUrl String http://test.com/501.html

Redirection page.

    └Status String success

Configuration status.

  └HttpHeaderConfigs

Configure response header (visible at the browser end).

    └ConfigId String 602016

Configuration ID.

    └HeaderKey String content-type

Response header supports parameters of any content.

    └HeaderValue String application

Response header supports parameters of any content, and to delete a header, enter null.

    └Status String success

Configuration status.

  └DynamicConfigs

Whole site acceleration configuration.

    └ConfigId String 20

Configuration ID.

    └DynamicOrigin String http

Source route scheme.

    └StaticType String jpg

When the file suffix and configuration content completely match, the dynamic acceleration is closed, and suffixes are separated by space.
Example: .jpg .txt .html.

    └StaticUri String yyy/ggss/ccc/a.txt

When URI and configuration content completely match, the dynamic acceleration is closed, and URIs are separated by space.
Example: /1/2/3.jpg /a/b/4.js.

    └StaticPath String /to/no_dynamic_rou

When URI and configuration content are in regular match, the dynamic acceleration is closed. Regular matches are separated by space, and URIs completely matches (^configuration content$). If you want to absolutely close dynamic acceleration, use slash (/) or space.
Example: /1 .py.

    └DynamicCacheControl String no-cache

When Cache-Control content matches any rules of cofiguration, the dynamic acceleration is opened. And other configuration is not checked.
Example: no-cache no-store.

    └Status String success

Configuration status.

  └ReqHeaderConfigs

Modify source custom header.

    └ConfigId String 123

Configuration ID.

    └Key String testKey

Source header.

    └Value String testValue

Source header content, and to delete the header, enter null.

    └Status String success

Configuration status.

  └SetVarsConfigs

Varible configuration.

    └ConfigId String 4125719

Configuration ID.

    └VarName String typeb

nginx variable that can be written already exists.

    └VarValue String typeb

Varible value, which can cite other varible.

    └Status String success

Configuration status.

  └CcConfig

Anti-cc attack.

    └ConfigId String 123

Configuration ID.

    └Enable String on

Open or close anti-CC attack.

    └AllowIps String 1.2.3.4

TMD anti-interception.

    └BlockIps String 3.4.5.6

IP blacklist.

    └Status String success

Configuration status.

  └ErrorPageConfig

Error page redirection.

    └ConfigId String 123

Configuration ID.

    └ErrorCode String 404

Error code.

    └PageType String charity

Type.

    └CustomPageUrl String http://promotion.alicdn.com/help/oss/error.html

Redirection page.

    └Status String success

Configuration status.

  └OptimizeConfig

Page optimization acceleration.

    └ConfigId String 123123

Configuration ID.

    └Enable String off

Switch.

    └Status String success

Configuration status.

  └PageCompressConfig

Page Gzip optimization.

    └ConfigId String 123

Configuration ID.

    └Enable String off

Switch.

    └Status String success

Configuration status.

  └IgnoreQueryStringConfig

Ignore URL parameter (retain).

    └ConfigId String 123

Configuration ID.

    └HashKeyArgs String time

Parameters list retained by Cached hashkey, separated by commas (,), and the content only supports 10 elements with 64 bits.

    └Enable String on

Cashed hashkey ignores all the parameters.

    └Status String success

Configuration status.

  └RangeConfig

Range request function.

    └ConfigId String 123

Configuration ID.

    └Enable String on

Switch.

    └Status String success

Configuration status.

  └RefererConfig

Referer blacklist and whitelist configuration.

    └ConfigId String 123

Configuration ID.

    └ReferType String block

Refer type.

    └ReferList String www.google.com

Refer domain name, separated by commas (,). The front and back ends does not include period (.). Suffix match.
Example: sina.com matches www.sina.com and www.ch.sina.com

    └AllowEmpty String on

Empty refer is allowed.

    └DisableAst String test

Close full stop (.) before domain name and use exact match.

    └Status String success

Configuration status.

  └ReqAuthConfig

Alibaba authentication.

    └ConfigId String 123

Configuration ID.

    └AuthType String type_c

Type.

    └Key1 String vadfawerq

Authentication keyA.

    └Key2 String Acbdert

Authentication keyB.

    └Status String success

Configuration status.

    └AliAuthWhiteList String test

Authentication whitelist.

    └AuthM3u8 String on

Enable m3u8 content rewriting function: (on|off).

    └AuthAddr String http://test.com/test

Remote authentication server address URL.

    └AuthRemoteDesc String test

Module string.

    └TimeOut String 2400

Custom authentication buffer time.

  └SrcHostConfig

Modify source Host header.

    └ConfigId String 123

Configuration ID.

    └DomainName String www.aliyun.com

Source Host header content.

    └Status String success

Configuration status.

  └VideoSeekConfig

Video slice drag/drop switch.

    └ConfigId String 123

Configuration ID.

    └Enable String on

Switch.

    └Status String success

Configuration status.

  └WafConfig

Anti-cross site scripting attack.

    └ConfigId String 123

Configuration ID.

    └Enable String off

Switch.

    └Status String success

Configuration status.

  └NotifyUrlConfig

Live.

    └Enable String on

Switch.

    └NotifyUrl String http://test.com

URL.

  └RedirectTypeConfig

Forced HTTP/HTTPS jump.

    └RedirectType String Https

Forced jump.

  └ForwardSchemeConfig

Swift adaptive source.

    └ConfigId String 123

Configuration ID.

    └Enable String on

Switch.

    └SchemeOrigin String http

Source site protocol (http|https|follow).

    └SchemeOriginPort String 80

Source site protocol port (80|443|80:443).

    └Status String success1

Configuration status.

  └RemoveQueryStringConfig

Ignore URL parameters (Delete).

    └AliRemoveArgs String time

Delete specified parameters. The remaining parameters are separated by space, and are part of URL args in hashkey.

    └ConfigId String 1123

Configuration ID.

    └Status String success

Configuration status.

  └L2OssKeyConfig

L2 OSS source private key.

    └PrivateOssAuth String on

Whether or not to open the private OSS authentication function.

    └ConfigId String 3512607

Configuration ID.

    └Status String success

Configuration status.

  └MacServiceConfig

Mobile acceleration.

    └AppList String app,app2

Applist.

    └Enabled String on

Switch.

    └ProcessResult String 0

  • 0: Configuration succeeds.
  • 1: mobile acceleration SDK configuration and submission failed.
  • 2: mobile acceleration scheduling node failed.
  • 3: mobile acceleration node configuration failed.
  • 4: mobile acceleration certificate generation failed.
  • 5: system error.

    └ConfigId String 3605171

Configuration ID.

    └Status String success

Configuration status.

  └GreenManagerConfig

Images porn detection.

    └Enabled String off

Switch.

    └ConfigId String 4047862

Configuration ID.

    └Status String success

Configuration status.

  └HttpsOptionConfig

HTTPS basic parameters.

    └Http2 String off

http2 switch.

    └ConfigId String 3498758

Configuration ID.

    └Status String success

Configuration status.

  └AliBusinessConfig

Custom for specific users.

    └AliBusinessTable String abc

Module string.

    └AliBusinessType String typea

Business type.

    └ConfigId String 4125638

Configuration ID.

    └Status String success

Configuration status.

  └IpAllowListConfig

IP whitelist.

    └ConfigId String 123

Configuration ID.

    └IpList String 8.8.8.8

Multiple IP lists are separated by comma.

    └IpAclXfwd String on

  • on: preferentially use the ip in xff header.
  • off: preferentially use remote_addr.
  • all: both match.

    └Status String success

Configuration status.

Example

Request example

  1. http://cdn.aliyuncs.com?Action=DescribeDomainConfigs&DomainName=test.com
  2. &ConfigList="cache_expired,cc,page_compress"&<Public request parameter>

Normal return example

JSON format

  1. {
  2. "DomainConfigs":{
  3. "AliBusinessConfig":{
  4. "AliBusinessType":"typea",
  5. "ConfigId":"4125638",
  6. "Status":"success"
  7. },
  8. "CacheExpiredConfigs":{
  9. "CacheExpiredConfig":[
  10. {
  11. "CacheContent":"jpeg",
  12. "CacheType":"suffix",
  13. "ConfigId":"604991",
  14. "Status":"testing",
  15. "TTL":"1000",
  16. "Weight":"1"
  17. },
  18. {
  19. "CacheContent":"jpg,png",
  20. "CacheType":"suffix",
  21. "ConfigId":"607216",
  22. "Status":"testing",
  23. "TTL":"600",
  24. "Weight":"99"
  25. }
  26. ]
  27. },
  28. "CcConfig":{
  29. "AllowIps":"1.2.3.4",
  30. "BlockIps":"3.4.5.6",
  31. "Enable":"on"
  32. },
  33. "DynamicConfigs":{
  34. "DynamicConfig":[{
  35. "ConfigId":"20",
  36. "DynamicCacheControl":"no-cache",
  37. "DynamicOrigin":"http",
  38. "StaticPath":"/to/no_dynamic_rou",
  39. "StaticType":"jpg",
  40. "StaticUri":"yyy/ggss/ccc/a.txt"
  41. }]
  42. },
  43. "ErrorPageConfig":{
  44. "CustomPageUrl":"http://promotion.alicdn.com/help/oss/error.html",
  45. "ErrorCode":"404",
  46. "PageType":"charity"
  47. },
  48. "GreenManagerConfig":{
  49. "ConfigId":"4047862",
  50. "Enabled":"off",
  51. "Status":"success"
  52. },
  53. "HttpErrorPageConfigs":{
  54. "HttpErrorPageConfig":[
  55. {
  56. "ErrorCode":"404",
  57. "PageUrl":"http://promotion.alicdn.com/help/oss/error.html"
  58. },
  59. {
  60. "ErrorCode":"501",
  61. "PageUrl":"http://test.com/501.html"
  62. },
  63. {
  64. "ErrorCode":"502",
  65. "PageUrl":"http://test.com/502.html"
  66. }
  67. ]
  68. },
  69. "HttpHeaderConfigs":{
  70. "HttpHeaderConfig":[
  71. {
  72. "ConfigId":"602016",
  73. "HeaderKey":"content-type",
  74. "HeaderValue":"application",
  75. "Status":"success"
  76. },
  77. {
  78. "ConfigId":"608841",
  79. "HeaderKey":"content-type",
  80. "HeaderValue":"app",
  81. "Status":"testing"
  82. },
  83. {
  84. "ConfigId":"602018",
  85. "HeaderKey":"cache-control",
  86. "HeaderValue":"application",
  87. "Status":"success"
  88. },
  89. {
  90. "ConfigId":"602021",
  91. "HeaderKey":"content-disposition",
  92. "HeaderValue":"application",
  93. "Status":"success"
  94. }
  95. ]
  96. },
  97. "HttpsOptionConfig":{
  98. "ConfigId":"3498758",
  99. "Http2":"off",
  100. "Status":"success"
  101. },
  102. "IgnoreQueryStringConfig":{
  103. "Enable":"on"
  104. },
  105. "L2OssKeyConfig":{
  106. "ConfigId":"3512607",
  107. "PrivateOssAuth":"on",
  108. "Status":"success"
  109. },
  110. "MacServiceConfig":{
  111. "AppList":"app,app2",
  112. "ConfigId":"3605171",
  113. "Enabled":"on",
  114. "Status":"success"
  115. },
  116. "NotifyUrlConfig":{
  117. "Enable":"on",
  118. "NotifyUrl":"http://test.com"
  119. },
  120. "OptimizeConfig":{
  121. "Enable":"off"
  122. },
  123. "PageCompressConfig":{
  124. "Enable":"off"
  125. },
  126. "RangeConfig":{
  127. "Enable":"on"
  128. },
  129. "RedirectTypeConfig":{
  130. "RedirectType":"Https"
  131. },
  132. "RefererConfig":{
  133. "AllowEmpty":"on",
  134. "ReferList":"www.google.com",
  135. "ReferType":"block"
  136. },
  137. "RemoveQueryStringConfig":{
  138. "AliRemoveArgs":"time",
  139. "ConfigId":"1123"
  140. },
  141. "ReqAuthConfig":{
  142. "AuthType":"type_c",
  143. "Key1":"vadfawerq",
  144. "Key2":"Acbdert",
  145. "TimeOut":"2400"
  146. },
  147. "ReqHeaderConfigs":{
  148. "ReqHeaderConfig":[{
  149. "ConfigId":"123",
  150. "Key":"testKey",
  151. "Value":"testValue"
  152. }]
  153. },
  154. "SetVarsConfigs":{
  155. "SetVarsConfig":[
  156. {
  157. "ConfigId":"4125719",
  158. "Status":"success",
  159. "VarName":"typeb",
  160. "VarValue":"typeb"
  161. },
  162. {
  163. "ConfigId":"4125726",
  164. "Status":"success",
  165. "VarName":"typea",
  166. "VarValue":"typea"
  167. }
  168. ]
  169. },
  170. "SrcHostConfig":{
  171. "DomainName":"www.aliyun.com"
  172. },
  173. "VideoSeekConfig":{
  174. "Enable":"on"
  175. },
  176. "WafConfig":{
  177. "Enable":"off"
  178. }
  179. },
  180. "RequestId":"67E027D8-7A58-4599-B17A-63E9A54FC54F"
  181. }

Exception return example

JSON format

  1. {
  2. "Code":"InternalError",
  3. "HostId":"cdn.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
  6. }

Error code

For more information, see Error code of this product.

Thank you! We've received your feedback.