查詢直播域名配置,一次可查詢多個功能配置。
使用說明
此接口一次可查詢多個功能配置。
QPS限制
本接口的單用戶QPS限制為100次/秒。超過限制,API調用會被限流,這可能會影響您的業(yè)務,請合理調用。更多信息,請參見QPS限制。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeLiveDomainConfigs | 系統(tǒng)規(guī)定參數。取值: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~99。 |
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:是否忽略所有參數。取值:僅支持on(忽略所有參數)或off(不忽略)。 |
aliauth:阿里鑒權。 |
auth_type:鑒權類型。取值:type_a(鑒權A)、no_auth(關閉鑒權)。 auth_key1:鑒權key1,鑒權key需為16~32個字符,支持大寫字母、小寫字母、數字。 auth_key2:鑒權key2。 ali_auth_delta:自定義鑒權緩沖時間,單位:秒。建議最小設置為60秒,無上限限制。 |
remote_auth:直播遠程鑒權 。 |
enable:是否開啟遠程鑒權,必填項。取值:on或off。 remote_auth_path : 鑒權服務器地址,必填項。 remote_auth_pattern :鑒權模式串。有以下功能可設置:
|
set_resp_header:設置響應頭(瀏覽器端可見)。 |
key:響應頭。 value:響應頭內容。刪除填寫null。 |
https_force:強制HTTPS跳轉。 |
enable:功能開關。取值:on或off。https_force和http_force只能存在其中一個,兩者為互斥關系,配置另外一個需要先刪除原來的配置。 |
http_force:強制HTTP跳轉。 |
enable:功能開關。取值:on或off。https_force和http_force只能存在其中一個,兩者為互斥關系,配置另外一個需要先刪除原來的配置。 |
l2_oss_key:L2 OSS 回源私鑰。 |
private_oss_auth:是否開啟私有OSS鑒權功能。取值:on或off。 |
green_manager:鑒黃功能。 |
enable:是否開啟鑒黃功能。取值:on或off。 |
tmd_signature:自定義的訪問頻次控制規(guī)則。 |
name:規(guī)則名稱。域名內不可重復。 path:可重復,需校驗uri路徑合法性。 pathType:匹配規(guī)則。0前綴匹配,1完全匹配。 interval:監(jiān)測時長。單位:秒。參數限制必須≥10。 count:單IP訪問次數。 action:阻斷類型。0封禁,1人機識別。 ttl:阻斷時長。單位:秒。 |
forward_scheme:自適應回源。 |
enable:功能開關,取值:on或off。 scheme_origin:回源站協(xié)議(http、https、follow)。 scheme_origin_port:回源站協(xié)議端口(80、443、80:443)。 |
video_seek:視頻切片拖拽開關。 |
enable:功能開關,取值:on或off。 |
gzip:頁面Gzip優(yōu)化。 |
enable:功能開關,取值:on或off。 |
tesla:頁面優(yōu)化加速。 |
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功能的地區(qū),取值:cn-beijing(北京)、cn-shanghai(上海)、cn-shenzhen(深圳)、cn-qingdao(青島)、apsoutheast-1(新加坡)、eu-central-1(德國)、ap-northeast-1(東京)、ap-southeast-5(雅加達)。 |
ali_location:區(qū)域限制訪問。 |
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。 |
https_option:http協(xié)議設置。 |
http2:是否開啟http2,默認為off。取值:on或off。 live_http2:是否開啟live_http2,默認為off。取值:on或off。 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED | 請求ID。 |
DomainConfigs | Array of DomainConfig | 直播域名配置。 |
|
DomainConfig | |||
Status | String | success | 配置狀態(tài),取值:
|
ConfigId | String | 5003576 | 配置ID。 |
FunctionName | String | set_req_host_header | 域名配置功能名稱。 |
FunctionArgs | Array of FunctionArg | 域名功能配置參數。 |
|
FunctionArg | |||
ArgName | String | domain_name | 參數名稱。 |
ArgValue | String | developer.aliyundoc.com | 參數值。 |
示例
請求示例
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainConfigs
&DomainName=demo.aliyundoc.com
&FunctionNames=set_req_host_header,set_hashkey_args
&<公共請求參數>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveDomainConfigsResponse>
<RequestId>F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED</RequestId>
<DomainConfigs>
<DomainConfig>
<Status>success</Status>
<FunctionName>set_req_host_header</FunctionName>
<ConfigId>5003576</ConfigId>
<FunctionArgs>
<FunctionArg>
<ArgValue>developer.aliyundoc.com</ArgValue>
<ArgName>domain_name</ArgName>
</FunctionArg>
</FunctionArgs>
</DomainConfig>
</DomainConfigs>
</DescribeLiveDomainConfigsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DescribeLiveDomainConfigsResponse" : {
"RequestId" : "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
"DomainConfigs" : {
"DomainConfig" : {
"Status" : "success",
"FunctionName" : "set_req_host_header",
"ConfigId" : 5003576,
"FunctionArgs" : {
"FunctionArg" : {
"ArgValue" : "developer.aliyundoc.com",
"ArgName" : "domain_name"
}
}
}
}
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。