调用BatchSetDcdnDomainConfigs实现域名批量配置功能。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchSetDcdnDomainConfigs |
系统规定参数。取值:BatchSetDcdnDomainConfigs。 |
DomainNames | String | 是 | example.com |
您的加速域名,多个域名使用英文逗号(,)分隔。 |
Functions | String | 是 | [{"functionArgs":[{"argName":"domain_name","argValue":"example.com"}],"functionName":"set_req_host_header"}] |
功能列表。格式如下:
|
Functions功能说明:所有参数值均按照字符串类型处理。
某些功能,例如filetype_based_ttl_set,可以设置多条记录,当需要更新其中某条记录时,可通过该条记录的configId来指定。
[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"}],"functionName":"filetype_based_ttl_set","configId":5068995}]
功能列表如下表所示。
名称 |
参数 |
---|---|
referer_white_list_set:Referer防盗链白名单 |
refer_domain_allow_list:白名单列表,多个使用英文逗号(,)分隔。 allow_empty:是否允许空Referer字段访问DCDN资源,取值:on或off。 |
referer_black_list_set:Referer防盗链黑名单 |
refer_domain_deny_list:黑名单列表,多个使用英文逗号(,)分隔。 allow_empty:是否允许空Referer字段访问DCDN资源,取值:on或off。 |
filetype_based_ttl_set:文件类型缓存过期时间设置 |
ttl:缓存时间,单位为秒。 file_type:文件类型,多个文件类型使用英文逗号(,)分隔,例如TXT,JPG。 |
path_based_ttl_set:目录类型缓存过期时间设置 |
ttl:缓存时间,单位为秒。 path:目录,必须以正斜线(/)开头。 |
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_list:IP列表,多个使用英文逗号(,)分隔。 |
error_page:错误页面重定向 |
error_code:错误码。 rewrite_page:重定向页面。 |
set_req_host_header:修改回源自定义头 |
domain_name:回源HOST头内容。 |
set_hashkey_args:保留URL参数 |
hashkey_args:保留参数的列表,多个使用英文逗号(,)分隔,最多支持填写10个。 disable: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:主KEY;auth_key2:备KEY。 ali_auth_delta:自定义鉴权缓冲时间。 |
set_resp_header:设置HTTP响应头(浏览器端可见) |
key:响应头,取值范围:Content-Type、Cache-Control、Content-Disposition、Content-Language、Expires、Access-Control-Allow-Origin、Access-Control-Allow-Methods、Access-Control-Allow-Headers、Access-Control-Max-Age、Access-Control-Expose-Headers。 value:响应头内容,删除填写null。 |
https_force:强制HTTPS跳转 |
enable:功能开关,取值:on或off。 |
http_force:强制HTTP跳转 |
enable:功能开关,取值:on或off。 |
https_option:HTTPS基础参数 |
http2:HTTP2开关,取值:on或off。 |
forward_scheme:静态协议跟随回源 |
enable:开关,取值:on或off。 scheme_origin:回源协议类型,支持http、https和follow(跟随)。 |
green_manager:鉴黄功能 |
enable:是否开启鉴黄功能,取值:on或off。 |
tmd_signature:频次控制自定义规则 |
name:规则名称,域名内不可重复。 path:可重复,需校验URI路径合法性。 pathType:匹配规则,0表示前缀匹配,1表示完全匹配。 interval:监测时长,单位为秒,参数限制必须大于等于10。 count:单IP访问次数。 action:阻断类型,0表示封禁,1表示人机识别。 ttl:阻断时长,单位为秒。 |
dynamic:全站加速相关配置 |
enable(必填):开关,支持on或off。 static_route_type:静态加速文件后缀。 static_route_url:静态加速URI。 static_route_path:静态加速PATH。 dynamic_route_origin:回源路由scheme,支持http、https、follow。 dynamic_route_round_robin:开启负载均衡开关,支持on或off。 dynamic_route_adapt_cache:开启自适应缓存开关,支持on或off。 |
set_req_header:自定义回源HTTP头 |
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结束参数。 |
websocket:Websocket |
enabled(必填):是否开启,取值:on或off。 origin_scheme:回源scheme,支持http、https和follow。 heartbeat:心跳时间,默认为60秒,支持1~300秒。 |
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(必填):过期时间,单位:ms,建议填写5184000000ms(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:页面Gzip优化 |
enable(必填):功能开关,支持on或off。 |
tesla:页面优化加速 |
enable(必填):功能开关,支持on或off。 |
protogw:IP应用加速 |
realip(必填):源站IP透传方式,支持off、toa、pp。 port(必填):服务端口。 |
quic:QUIC基础参数 |
quic_enable:quic开关,支持on或off。 |
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回源自定义头 |
key:回源头。 value:回源头内容,删除头请填写null。 |
host_redirect:rewrite功能 |
regex:需要重写的URL,例如:^/$。 replacement:目标URL,例如: /go/act/sale/tbzlsy.php。 flag:支持redirect、break。 |
forward_timeout:回源请求超时 |
forward_timeout:单位为s,一般不要配置大于100。 |
ali_video_split:音视频分离 |
enabled:开关,支持on或off。 |
ipv6:ipv6配置 |
switch(必填):开关,支持on或off,开启功能。一旦开启后,如需关闭请取消勾选,不要删除配置,否则不生效。 region:开启ipv6功能的地区,支持星号(*)。 |
default_ttl_code:状态码缓存时间 |
default_ttl_code(必填):状态码默认缓存时间,单位为秒,多个状态码使用英文逗号(, )分隔,例如4xx=3,200=3600,5xx=1。注意:该功能用于按响应状态码设置文件在全站加速的默认缓存时间,如果源站响应头中包含expires和cache-control头,则以源站的配置优先。 |
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:规则执行位置。全站加速域名仅支持head,不支持foot。 brk:命中本条规则后,当前执行位置剩余规则均跳过。 option:option管控。 grammar:grammar管控,取值范围:空、es2、js。 jsmode:js域名白单管控,取值范围:redirect、bypass。 |
origin_certificate_verification:回源证书校验 |
enable(必填):开关,取值on或off,on表示开启回源证书校验,off表示关闭回源证书校验。 common_name_whitelist:表示证书白名单列表,匹配了白名单的证书可以通过校验。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE73368 |
请求ID。 |
示例
请求示例
http(s)://dcdn.aliyuncs.com/?Action=BatchSetDcdnDomainConfigs
&DomainNames=example.com
&Functions=[{"functionArgs":[{"argName":"domain_name","argValue":"example.com"}],"functionName":"set_req_host_header"}]
&<公共请求参数>
正常返回示例
XML
格式
<BatchSetDcdnDomainConfigsResponse>
<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</BatchSetDcdnDomainConfigsResponse>
JSON
格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidFunctions.Malformed | The specified Functions is invalid. | 不支持该配置,请重新填写。 |
400 | InvalidArgValue.Malformed | The specified ArgValue is invalid. | ArgValue错误,请重新填写。 |
400 | Invalid%s.ValueNotSupported | [%s] is not supported. | 不支持该设置。 |
400 | Invalid%s.Malformed | The specified ArgValue [%s] is invalid. | 不支持该ArgValue,请填写正确的ArgValue。 |
400 | MissingParameter | You must specify ArgValue. | 缺少参数。 |
访问错误中心查看更多错误码。