BatchSetVsDomainConfigs_域名操作接口_API参考

描述

域名批量配置

请求参数

参数名	类型	是否必须	说明
Action	String	是	操作接口名，系统规定参数，取值：BatchSetVsDomainConfigs
DomainNames	String	是	您的加速域名，多个用英文半角逗号分隔
Functions	Json	是	功能列表

Functions格式

[{“functionArgs”:[{“argName”:”domain_name”,”argValue”:”api.hellodtworld.com”}],”functionName”:”set_req_host_header”}]
某些功能，如filetype_based_ttl_set，可以设置多条纪录，当需要更新其中某条纪录时，可通过该条纪录的configId来指定。[{“functionArgs”:[{“argName”:”file_type”,”argValue”:”jpg”},{“argName”:”ttl”,”argValue”:”18”},{“argName”:”weight”,”argValue”:”30”}],”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； weight：权重：取值范围1~199
path_based_ttl_set：目录过期时间设置	ttl：cache时间，单位：秒； path：目录，必须以”/“开头； weight：权重：取值范围1~99
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：错误页面重定向	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：私有Bucket回源	private_oss_auth：私有Bucket回源开关，支持on/off
range：range回源	enable：开关，支持on/off/force
video_seek：视频拖拽播放	enable：开关，支持on/off
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:页面Gzip优化	enable：必填，功能开关，支持on/off
tesla:页面优化加速	enable：必填，功能开关，支持on/off

返回参数

名称	类型	描述
RequestId	String	该条任务请求Id

特殊错误码

错误代码	描述	Http 状态码	语义
InvalidFunctions.Malformed	Specified Functions is malformed.	400	指定的 Functions 不合法
InvalidFunctionName.ValueNotSupported	FunctionName %s is not supported.	400	不支持的FunctionName %s(%s为具体功能名)
InvalidArgName.ValueNotSupported	ArgName %s is not supported.	400	不支持的ArgName %s(%s为具体参数名)
InvalidArgValue.Malformed	Specified ArgValue is malformed.	400	指定的 ArgValue 不合法

示例

请求示例：

http://vs.aliyuncs.com/?Action=BatchSetVsDomainConfigs
&DomainName=example1.com,example2.com
&Functions=[{"functionArgs":[{"argName":"domain_name","argValue":"api.hellodtworld.com"}],"functionName":"set_req_host_header"}]
&<公共请求参数>

返回示例

JSON格式：

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}