调用BatchSetDcdnIpaDomainConfigs批量配置IPA层应用加速域名。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchSetDcdnIpaDomainConfigs |
系统规定参数。取值:BatchSetDcdnIpaDomainConfigs。 |
DomainNames | String | 是 | example.com |
IPA层应用加速域名,多个域名使用英文逗号(,)分隔。 |
Functions | String | 是 | [{"functionArgs":[{"argName":"domain_name","argValue":"api.xxx.com"}],"functionName":"set_req_host_header"}] |
功能列表。
|
某些功能,例如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:refer白名单 |
refer_domain_allow_list:白名单列表,多个使用英文逗号(,)分隔。 allow_empty:是否允许空refer进入,取值:on或off。 |
referer_black_list_set:refer黑名单 |
refer_domain_deny_list:黑名单列表,多个使用英文逗号(,)分隔。 allow_empty:是否允许空refer进入,取值:on或off。 |
filetype_based_ttl_set:文件过期时间设置 |
ttl:cache时间,单位为秒。 file_type:文件类型。多个使用英文逗号(,)分隔,例如txt,jpg。 |
path_based_ttl_set:目录过期时间设置 |
ttl:cache时间,单位为秒。 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:TMD免拦截 |
ip_list:IP列表,多个使用英文逗号(,)分隔。 |
error_page:错误页面重定向回源Host头内容 |
error_code:错误码。 rewrite_page:重定向页面。 |
set_req_host_header:修改回源自定义头 |
domain_name:回源Host头内容。 |
set_hashkey_args:忽略url参数 |
hashkey_args:保留参数的列表,多个用逗号(,)分隔。 disable:disable等于on的时候表示忽略所有参数,off不忽略。 |
aliauth:阿里鉴权 |
auth_type:鉴权类型。取值范围:no_auth、type_a、type_b、type_c。 auth_key1:鉴权key1;auth_key2:鉴权key2。 ali_auth_delta:自定义鉴权缓冲时间。 |
set_resp_header:设置响应头(浏览器端可见) |
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。 |
l2_oss_key:L2 OSS 回源私钥 |
private_oss_auth:是否开启私有oss鉴权功能,取值范围:on或off。 |
forward_scheme:静态协议跟随回源 |
enable:开关,取值范围:on或off。 scheme_origin:回源站协议,支持http、https和follow。 |
green_manager:鉴黄功能 |
enable:是否开启鉴黄功能,取值范围:on或off。 |
tmd_signature:TMD自定义规则 |
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。 |
set_req_header:自定义回源HTTP头 |
key:回源头。 value:回源头内容。 |
l2_oss_key:私有buckct回源 |
private_oss_auth:私有Bucket回源开关,支持on或off。 |
range:range回源 |
enable:开关,支持on或off。 |
video_seek:视频拖拽播放 |
enable:开关,支持on或off。 |
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:服务端口。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 0AEDAF20-4DDF-4165-8750-47FF9C1929C9 |
请求ID。 |
示例
请求示例
http(s)://dcdn.aliyuncs.com/?Action=BatchSetDcdnIpaDomainConfigs
&DomainNames=example.com
&Functions=[{"functionArgs":[{"argName":"domain_name","argValue":"api.xxx.com"}],"functionName":"set_req_host_header"}]
&<公共请求参数>
正常返回示例
XML
格式
<BatchSetDcdnIpaDomainConfigsResponse>
<RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>
</BatchSetDcdnIpaDomainConfigsResponse>
JSON
格式
{
"RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}
错误码
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。 |
403 | DcdnIpaServiceNotFound | The DCDN IPA service has not been activated. | 没有开通DCDN IPA服务。 |
访问错误中心查看更多错误码。