BatchSetVsDomainConfigs - 批量配置域名

域名批量配置。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vs:BatchSetVsDomainConfigs
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DomainNamesstring

您的加速域名。

说明 支持多个,用英文逗号(,)分隔。
example.aliyundoc.com
Functionsstring

功能列表。

[{“functionArgs”:[{“argName”:”domain_name”,”argValue”:”api.hellodtworld.com”}],”functionName”:”set_req_host_header”}]

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 鉴权 Bucketoss_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:修改回源自定义头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:配置频次控制自定义规则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:HSTSenabled:开关(必填)。默认: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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

9BEC5E85-C76B-56EF-A922-860EFDB8B64B

示例

正常返回示例

JSON格式

{
  "RequestId": "9BEC5E85-C76B-56EF-A922-860EFDB8B64B"
}

错误码

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

特殊错误码

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