调用DescribeLiveDomainConfigs查询直播域名配置。
使用说明
此接口一次可查询多个功能配置。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveDomainConfigs |
系统规定参数。取值:DescribeLiveDomainConfigs。 |
DomainName | String | 是 | demo.aliyundoc.com |
您的推流域名或播流域名。 |
FunctionNames | String | 是 | set_req_host_header,set_hashkey_args |
功能列表名称。多个功能使用英文逗号(,)分隔。更多详情,请参见下表Functions功能说明。 |
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:访问频次控制免拦截。 |
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:鉴权类型。取值:type_a(鉴权A)、no_auth(关闭鉴权)。 auth_key1:鉴权key1,鉴权key需为16~32个字符,支持大写字母、小写字母、数字。 auth_key2:鉴权key2。 ali_auth_delta:自定义鉴权缓冲时间。 |
set_resp_header:设置响应头(浏览器端可见)。 |
key:响应头。 value:响应头内容。删除填写null。 |
https_force:强制HTTPS跳转。 |
enable:功能开关。取值:on或off。 |
http_force:强制HTTP跳转。 |
enable:功能开关。取值:on或off。 |
l2_oss_key:L2 OSS 回源私钥。 |
private_oss_auth:是否开启私有OSS鉴权功能。取值:on或off。 |
green_manager:鉴黄功能。 |
enable:是否开启鉴黄功能。取值:on或off。 |
tmd_signature:自定义的访问频次控制规则。 |
name:规则名称。域名内不可重复。 path:可重复,需校验uri路径合法性。 pathType:匹配规则。0前缀匹配,1完全匹配。 interval:监测时长。单位:秒。参数限制必须≥10。 count:单IP访问次数。 action:阻断类型。0封禁,1人机识别。 ttl:阻断时长。单位:秒。 |
forward_scheme:自适应回源。 |
enable:功能开关,取值:on或off。 scheme_origin:回源站协议(http、https、follow)。 scheme_origin_port:回源站协议端口(80、443、80:443)。 |
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。 |
enable:功能开关。 |
取值:on或off。 |
live_forbid_flv:禁止播放flv。 |
取值:on或off。 |
live_forbid_rtmp:禁止播放rtmp。 |
取值:on或off。 |
live_forbid_hls:禁止播放hls。 |
取值:on或off。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainConfigs | Array of DomainConfig |
直播域名配置。 |
|
DomainConfig |