调用BatchSetLiveDomainConfigs批量配置域名。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchSetLiveDomainConfigs |
系统规定参数。取值:BatchSetLiveDomainConfigs。 |
DomainNames | String | 是 | play.yourdomain.com |
播流域名。多个域名用英文逗号(,)分隔。 |
Functions | String | 是 | [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}] |
功能列表。 某些功能,如 |
Functions功能说明
名称 |
参数 |
---|---|
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:文件类型。多个使用英文逗号(,)隔开。 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:修改回源Host头。 |
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<br>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。 |
forward_scheme:自适应回源。 |
enable:功能开关,取值:on或off。 scheme_origin:回源站协议 (http、https、follow)。 scheme_origin_port:回源站协议端口(80、443、80:443)。 |
green_manager:鉴黄功能。 |
enable:是否开启鉴黄功能。取值:on或off。 |
tmd_signature:TMD自定义规则。 |
name:规则名称。域名内不可重复。 path:可重复,需校验URI路径合法性。 pathType:匹配规则。0前缀匹配,1完全匹配。 interval:监测时长。单位:秒。参数限制必须≥10。 count:单IP访问次数。 action:阻断类型。0封禁,1人机识别。 ttl:阻断时长。单位:秒。 |
l2_oss_key:L2 OSS 回源私钥 |
private_oss_auth:是否开启私有oss鉴权功能。取值:on或off。 |
range:Range请求功能 |
enable:功能开关。取值:on或off。 |
video_seek:视频切片拖拽开关 |
enable:功能开关。取值:on或off。 |
gzip:页面Gzip优化 |
enable:功能开关。取值:on或off。 |
tesla:页面优化加速 |
enable:功能开关。取值:on或off。 |
ali_ua:User-Agent限制访问 |
ua:User-Agent。 type:名单类型。取值black和white。 |
host_redirect:rewrite功能 |
regex:需要重写的URL。例如 ^/$。 replacement:目标URL。例如 /go/act/sale/tbzlsy.php。 flag:仅支持:redirect、break。 |
ipv6:ipv6配置 |
switch:开关(必填)。取值:on或off,开启功能,一旦开启后,如需关闭请取消勾选,不要删除配置,否则不生效。 region:开启IPv6功能的地域。 |
ali_location:区域限制访问 |
location:地域列表。 type:名单类型。取值black或white。 |
cc_defense:防CC攻击 |
enable:开启或关闭防CC攻击。取值:on或off。 |
alilive:视频直播配置 |
notify_url:直播通知url enable:功能开关。取值:on或off。 live_forbid_flv:禁止播放flv。取值:on或off。 live_forbid_rtmp:禁止播放rtmp。取值:on或off。 live_forbid_hls:禁止播放hls。取值:on或off。 |
ali_grtn:grtn业务接入开关 |
grtn_rts_pub:RTS推流开关,推流域名使用。取值:on或off。 grtn_rts_play:RTS播流开关,播流域名使用。取值:on或off。 |
edge_function:边缘函数 |
必填参数 rule:DSL规则 pri:优先级 enable:本条规则是否生效。取值:on或off。 可选参数: name:规则名称。 pos:规则执行位置。 brk:命中本条规则后,当前执行位置剩余规则均跳过。 option:option管控。 grammar:grammar管控。可选值:空、es2、js。 jsmode:js域名白单管控,可选值:redirect或bypass |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE73368 |
请求ID。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=BatchSetLiveDomainConfigs
&DomainNames=play.yourdomain.com
&Functions= [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]
&<公共请求参数>
正常返回示例
XML
格式
<BatchSetLiveDomainConfigsResponse>
<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</BatchSetLiveDomainConfigsResponse>
JSON
格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
错误码
访问错误中心查看更多错误码。
错误代码 |
描述 |
Http 状态码 |
语义 |
---|---|---|---|
InvalidFunctions.Malformed |
Specified Functions is malformed. |
400 |
指定的Functions不合法。 |
InvalidFunctionName.ValueNotSupported |
unctionName %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不合法。 |