调用BatchSetLiveDomainConfigs批量配置域名_视频直播(LIVE)-阿里云帮助中心

使用说明

先获取需要进行配置的直播域名，再调用本接口批量配置域名。

QPS限制

本接口的单用户QPS限制为30次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	BatchSetLiveDomainConfigs	系统规定参数。取值：BatchSetLiveDomainConfigs。
DomainNames	String	是	demo.aliyundoc.com,example.aliyundoc.com,example.com	需要进行批量配置的域名。取值可以是推流域名、主播流域名或子播流域名。多个域名用英文逗号（,）分隔。
Functions	String	是	[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]	功能列表。某些功能，如`filetype_based_ttl_set`，可以设置多条记录，当需要更新其中某条记录时，可通过该条记录的`configId`来指定。更多信息，请参见下表Function格式说明和Functions功能说明。

Functions格式说明

示例如下所示：[{"functionArgs":[{"argName":"domain_name","argValue":"developer.aliyundoc.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":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时间。单位：秒，取值范围是1~99999999（3年多一些）。 file_type：文件类型。多个使用英文逗号（,）隔开。 weight：权重。取值范围：1~99。
path_based_ttl_set：目录过期时间设置。	ttl：cache时间。单位：秒，取值范围是1~99999999（3年多一些）。 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：访问频次控制免拦截。	ip_list：IP列表。多个使用英文逗号（,）隔开。
error_page：错误页面重定向。	error_code：错误码。 rewrite_page：重定向页面。
set_req_host_header：修改回源Host头。	domain_name：回源Host头内容。
set_hashkey_args：忽略URL参数。	hashkey_args：保留参数的列表。多个使用英文逗号（,）分隔。 disable：是否忽略所有参数。取值：仅支持on（忽略所有参数）或off（不忽略）。
aliauth：阿里鉴权。	auth_type：鉴权类型。取值：type_a（鉴权A）、no_auth（关闭鉴权）。 auth_key1：鉴权key1，鉴权key支持大写字母、小写字母、数字，建议设置长度为8~32个字符。 auth_key2：鉴权key2。 ali_auth_delta：自定义鉴权缓冲时间，单位：分钟。建议最小设置为1分钟，无上限限制。 auth_m3u8：是否开启m3u8内容改写，对m3u8里面的ts补齐对应的鉴权，可以避免ts的访问鉴权失败。取值：on（默认值）或off。
remote_auth：直播远程鉴权。	enable：是否开启远程鉴权，必填项。取值：on或off。 remote_auth_path ：鉴权服务器地址，必填项。 remote_auth_pattern ：鉴权模式串。有以下功能可设置： param：是否向鉴权服务器透传推流URL中的参数，取值pass（默认）或fail。 args_white：透传指定参数设置，多个参数用英文逗号（,）分隔。 args_black：不透传指定参数设置，多个参数用英文逗号（,）分隔。 code：鉴权状态码，code=XXX，鉴权服务器在鉴权成功时返回给直播的HTTP状态码。例如：code=200。code=~XXX，鉴权服务器在鉴权失败时返回给直播的HTTP状态码。例如：code=~403。 delta ：鉴权超时时长。 retry：鉴权超时重试次数。 timeout：鉴权超时行为，取值：pass或fail。pass：视频直播将直接通过用户请求。fail：视频直播将响应鉴权失败状态码（403）给用户。 async：异步鉴权，取值on（开启异步鉴权）或off（默认，关闭异步鉴权）。
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。https_force和http_force只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。
http_force：强制HTTP跳转。	enable：功能开关。取值：on或off。https_force和http_force只能存在其中一个，两者为互斥关系，配置另外一个需要先删除原来的配置。
forward_scheme：自适应回源。	enable：功能开关，取值：on或off。 scheme_origin：回源站协议（http、https、follow）。 scheme_origin_port：回源站协议端口（80、443、80:443）。
green_manager：鉴黄功能。	enable：是否开启鉴黄功能。取值：on或off。
tmd_signature：自定义的访问频次控制规则。	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。
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功能的地域，取值：cn-beijing（北京）、cn-shanghai（上海）、cn-shenzhen（深圳）、cn-qingdao（青岛）、apsoutheast-1（新加坡）、eu-central-1（德国）、ap-northeast-1（东京）、ap-southeast-5（雅加达）。
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。 grtn_rts_transcode：RTS H5播放自动转码开关。取值：on或off。
edge_function：边缘函数。	必填参数： rule：DSL规则。 pri：优先级。 enable：本条规则是否生效。取值：on或off。可选参数： name：规则名称。 pos：规则执行位置。 brk：命中本条规则后，当前执行位置剩余规则均跳过。 option：option管控。 grammar：grammar管控。可选值：空、es2、js。 jsmode：js域名白单管控，可选值：redirect或bypass。
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，默认为on。取值：on或off。
https_option：http协议设置。	http2：是否开启http2，默认为off。取值：on或off。 live_http2：是否开启live_http2，默认为off。取值：on或off。

返回数据

名称	类型	示例值	描述
RequestId	String	04F0F334-1335-436C-A1D7-6C044FE73368	请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=BatchSetLiveDomainConfigs
&DomainNames=demo.aliyundoc.com,example.aliyundoc.com,example.com
&Functions= [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<BatchSetLiveDomainConfigsResponse>
	<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</BatchSetLiveDomainConfigsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode	错误码	错误信息	描述
400	ConfigurationConflicts	The staging environment has a configuration in effect and cannot modify the production environment configuration.	预发环境存在已生效配置，无法修改生产环境配置。

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

错误代码	描述	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不合法。