调用DescribeCdnDomainConfigs获取加速域名的配置信息,一次可查询多个功能配置信息。

说明 单用户调用频率:100次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCdnDomainConfigs

系统规定参数。取值:DescribeCdnDomainConfigs

DomainName String example.com

加速域名,仅支持查询单个域名。

FunctionNames String aliauth

功能列表名称,多个用英文逗号(,)分隔。

功能列表如下表所示。

名称

参数

referer_white_list_set:Referer白名单

refer_domain_allow_list:白名单列表,多个用英文逗号(,)分隔。

allow_empty:是否允许空Referer字段访问CDN资源,取值:on或off。

referer_black_list_set:Referer黑名单

refer_domain_deny_list:黑名单列表,多个用英文逗号(,)分隔。

allow_empty:是否允许空Referer字段访问CDN资源,取值:on或off。

filetype_based_ttl_set:文件类型缓存过期时间设置

ttl:缓存时间,单位为秒。

file_type:文件类型。多个文件类型用英文逗号(,)分隔,例如TXT,JPG。

weight:权重。最大为99,最小为1,数字越大优先级越高。

path_based_ttl_set:目录类型缓存过期时间设置

ttl:缓存时间,单位为秒。

path:目录,必须以正斜线(/)开头。

weight:权重。最大为99,最小为1,数字越大优先级越高。

oss_auth:OSS鉴权Bucket

oss_bucket_id:您的Bucket地址。

ip_black_list_set:IP黑名单

ip_list:IP列表,多个用英文逗号(,)分隔。

ip_allow_list_set:IP白名单

ip_list:IP列表,多个用英文逗号(,)分隔。

ip_white_list_set:频次控制IP白名单

ip_list:IP列表,多个用英文逗号(,)分隔。

error_page:错误页面重定向

error_code:错误码。

rewrite_page:重定向页面。

set_req_host_header:修改回源HOST头

domain_name:回源HOST头内容。

set_hashkey_args:保留URL参数

hashkey_args:保留参数列表,多个用英文逗号(,)分隔,最多支持填写10个。

disable:等于on,表示忽略所有参数,off表示不忽略(缓存hashkey忽略所有参数,优先级低于保留缓存参数列表功能)。

keep_oss_args:等于on,表示回源保留所有参数,off表示与缓存hashkey的参数一致。

aliauth:阿里鉴权

auth_type:鉴权类型。no_auth:无鉴权;type_a:鉴权方式A;type_b:鉴权方式B;type_c:鉴权方式C。

auth_key1:鉴权key1;auth_key2:鉴权key2。

ali_auth_delta:自定义鉴权缓冲时间。

set_resp_header:设置HTTP响应头(浏览器端可见)

key(必填):响应头。

value(必填):响应头内容,删除填写null。

header_operation_type:请求头操作,支持add、delete、modify和rewrite。add:添加,delete:删除,modify:变更,rewrite:替换。

duplicate:是否允许重复,取值:on或off。

header_source:查找。

header_destination:替换。

match_all:匹配所有,取值:on或off。

https_force:强制HTTPS跳转

enable:功能开关,取值:on或off。

http_force:强制HTTP跳转

enable:功能开关,取值:on或off。

https_option:HTTPS基础参数

http2:HTTP2开关,取值:on或off。

ocsp_stapling:OCSP Stapling开关,取值:on或off。

forward_scheme:静态协议跟随回源

enable:开关,取值:on或off。

scheme_origin:回源协议类型,支持http、https和follow(跟随)。

set_req_header:回源HTTP请求头

set_req_header是v1版本,建议您使用v2版本:origin_request_header,功能更丰富。

key:回源头。

value:回源头内容。

l2_oss_key:阿里云OSS私有Bucket回源

private_oss_auth:私有Bucket回源开关,支持on或off。

range:range回源

enable:开关,支持on、off、force(强制)。

video_seek:视频拖拽播放

enable(必填):开关,支持on或off。

flv_seek_by_time:开启FLV按时间拖拽,支持on或off。

mp4_seek_start:自定义MP4开始参数。

mp4_seek_end:自定义MP4结束参数。

flv_seek_start:自定义FLV开始参数。

flv_seek_end:自定义FLV结束参数。

ali_remove_args:忽略URL参数

ali_remove_args(必填):删除指定的参数,多个参数之间用空格隔开,剩余参数将作为hashkey中URL args部分。

keep_oss_args:回源保留参数。支持on或off,on表示回源保留所有参数,off表示与缓存hashkey的参数一致。

https_tls_version:TLS协议版本

tls10:开启 TLSv1.0 默认:on,支持on或off。

tls11:开启 TLSv1.1 默认:on,支持on或off。

tls12:开启 TLSv1.2 默认:on,支持on或off。

tls13:开启 TLSv1.3 默认:off,支持on或off。

HSTS:HSTS

enabled(必填):开关,默认为off,支持on或off。

https_hsts_max_age(必填):过期时间,单位:s,建议填写5184000s(60天)。

https_hsts_include_subdomains: HSTS头包含includeSubDomains参数,支持on或off。请谨慎开启,开启前请确保该加速域名的所有子域名都已开启HTTPS,否则会导致子域名自动跳转到HTTPS后无法访问。

filetype_force_ttl_code:文件状态码过期时间设置

file_type(必填):文件类型,多个用英文逗号(,)分隔,例如:TXT,JPG。

code_string(必填):状态码,多个用英文逗号(,)分隔。例如:302=0,301=0,4xx=2。

path_force_ttl_code:路径状态码过期时间设置

path(必填):必须以正斜线(/)开头,例如:/image。

code_string(必填):状态码,多个用英文逗号(,)分隔。例如:302=0,301=0,4xx=2。

gzip:智能压缩

enable(必填):功能开关,支持on或off。

tesla:页面优化

enable(必填):功能开关,支持on或off。

trim_js:支持on或off,开启该功能,优化html中内嵌的js代码。

trim_css:支持on或off,开启该功能,优化html中内嵌的css代码。

https_origin_sni:回源SNI

enabled(必填):功能开关,支持on或off。

https_origin_sni(必填):回源SNI。

limit_rate:单请求限速

ali_limit_rate(必填):默认限速,限速多少(例如200k、1m等),单位Byte/s。

ali_limit_rate_after:不限速大小,在发送了多少数据之后限速,单位Byte。

traffic_limit_arg:限速参数名称,根据URL中提取的arg进行限速,例如:rate。

traffic_limit_unit:限速参数单位,支持m、k、g,当rate=1,则限速1m或1k或1g。

ali_limit_start_hour:限速开始时间,取值范围[0,24],小于限速结束时间,默认值为0。

ali_limit_end_hour:限速结束时间,取值范围[0,24],大于限速开始时间,默认值为24。

brotli:Brotli压缩

enable(必填):功能开关,支持on或off。

brotli_level:压缩等级,取值范围[1,11]。

ali_ua:User-Agent黑/白名单

ua:User-Agent。

type:名单类型,black或white。

set_l2_req_header:L2节点回源HTTP请求头

set_l2_req_header是v1版本,建议您使用v2版本:origin_request_header,功能更丰富。

key:回源头。

value:回源头内容,删除头请填写null。

host_redirect:URL重写

regex:需要重写的URL,例如:^/$。

replacement:目标URL,例如: /go/act/sale/tbzlsy.php。

flag:仅支持redirect、break。

forward_timeout:回源请求超时时间

forward_timeout:单位为秒,配置时建议不要大于100秒。

ali_video_split:音视频分离

enabled:开关,支持on或off。

ipv6:ipv6配置

switch(必填):开关,支持on或off,on表示开启,off表示关闭。

region:开启IPv6功能的地区,支持星号(*)。

ali_video_preview:视频试看

enable(必填):开关,支持on或off,支持TS、MP3文件格式,FLV和MP4使用拖拽功能实现。

ali_video_preview_argument(必填):自定义试看参数名,试看参数值的单位必须是秒。

default_ttl_code:状态码缓存时间

default_ttl_code(必填):状态码默认缓存时间,单位为秒,例如:4xx=3,200=3600,5xx=1,多个使用英文逗号(,)分隔。

back_to_origin_argument_rewrite:回源参数改写

优先级:添加参数>删除参数>仅保留参数>修改参数。多个参数用空格分隔。

delete_argument:删除参数列表。

save_argument:保留参数列表。仅保留列出的参数,添加参数和删除参数仍会生效。

ignore_all_argument:支持on或off,忽略所有参数,回源的时候将会删除所有参数,但是通过添加参数功能添加的参数仍然能够生效。

add_argument:添加参数,优先级最高。

modify_argument:修改参数,优先级最低,若参数被删除则不会保留。

back_to_origin_url_rewrite:回源URL改写

source_url(必填):需要被重写的URL。

target_url(必填):重写的目标URL。

flag:改写操作的执行规则,仅支持:空、break、enhance_break。空:执行完该条规则后,后续rewrite规则会继续执行;break:执行完该条规则后,后续rewrite规则不再执行;enhance_break:类似break,区别在于会带着参数一起进行处理,并且针对flv直播也会生效。

edge_function:边缘函数

rule(必填):DSL规则。

pri(必填):优先级。

enable(必填):本条规则是否生效,取值范围on或off。

name:规则名称。

pos:规则执行位置。

brk:命中本条规则后,当前执行位置剩余规则均跳过。

option:option管控。

grammar:grammar管控,取值范围:空、es2、js。

jsmode:js域名白单管控,取值范围:redirect、bypass。

follow_302:302跟随

enable(必填):开关,支持on或off。

max_tries:302跟随上限,例如n+1次,n最大不可超过5,默认为3,即允许跟随次数为2+1=3次。

aws_s3_bucket:AWS s3鉴权bucket

enabled(必填):开关,支持l2或off。

bucketname:Amazon S3 bucket名称。

accesskey(必填):AWS AccessKey。

secretkey(必填):AWS SecretKey。

region(必填):Amazon S3存储区域。

origin_request_header:回源HTTP请求头(新)

header_operation_type(必填):请求头操作,支持add、delete、modify和rewrite,add:添加,delete:删除,modify:变更,rewrite:替换。

header_name(必填):请求头名称。

header_value:请求头值。

duplicate:是否允许重复,取值on或off。

header_source:查找。

header_destination:替换。

match_all:匹配所有,支持on或off。

origin_response_header:回源HTTP响应头

header_operation_type(必填):响应头操作,支持add、delete、modify和rewrite,add:添加,delete:删除,modify:变更,rewrite:替换。

header_name(必填):响应头名称。

header_value:响应头值。

duplicate:是否允许重复,取值on或off。

header_source:查找。

header_destination:替换。

match_all:匹配所有,支持on或off。

返回数据

名称 类型 示例值 描述
DomainConfigs Array of DomainConfig

域名配置。

DomainConfig
ConfigId String 6295

配置ID。

FunctionArgs Array of FunctionArg

各个功能说明。

FunctionArg
ArgName String auth_type

配置名称。

ArgValue String req_auth

配置值。

FunctionName String aliauth

功能名称。

Status String success

配置状态。取值:

  • success:成功。
  • testing:测试中。
  • failed:失败。
  • configuring:配置中。
RequestId String C80705BF-0F76-41FA-BAD1-5B59296A4E59

请求ID。

示例

请求示例

http(s)://cdn.aliyuncs.com/?Action=DescribeCdnDomainConfigs
&DomainName=example.com
&FunctionNames=aliauth
&<公共请求参数>

正常返回示例

XML格式

<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格式

{
    "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"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 Invalid%s.ValueNotSupported FunctionName [%s] is not supported. 此方法不支持。

访问错误中心查看更多错误码。