查詢直播域名配置，一次可查詢多個功能配置。
接口說明
使用說明
此接口一次可查詢多個功能配置。
QPS 限制
本接口的單用戶 QPS 限制為 100 次/秒。超過限制，API 調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| live:DescribeLiveDomainConfigs | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 是 | 您的推流域名或播流域名。 | demo.aliyundoc.com |
| FunctionNames | string | 是 | 功能列表名稱。多個功能使用英文逗號（,）分隔。更多詳情，請參見下表Functions 功能說明。 | set_req_host_header,set_hashkey_args |
Functions 功能說明
說明
所有參數值均按照字符串類型處理。 某些功能，例如：filetype_based_ttl_set，可以設置多條紀錄。當需要更新其中某條紀錄時，可通過該條紀錄的 configId 來指定。
| 名稱 | 參數 |
|---|---|
| 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 ：鑒權模式串。有以下功能可設置： - 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：響應頭。 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：自定義的訪問頻次控制規則。 | 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）。 |
| 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。 |
| enable：功能開關。 | 取值：on 或 off。 |
| live_forbid_flv：禁止播放 flv。 | 取值：on 或 off。 |
| live_forbid_rtmp：禁止播放 rtmp。 | 取值：on 或 off。 |
| live_forbid_hls：禁止播放 hls。 | 取值：on 或 off。 |
| https_option：http 協議設置。 | http2：是否開啟 http2，默認為 off。取值：on 或 off。 live_http2：是否開啟 live_http2，默認為 off。取值：on 或 off。 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
"DomainConfigs": {
"DomainConfig": [
{
"Status": "success",
"ConfigId": "5003576",
"FunctionName": "set_req_host_header",
"FunctionArgs": {
"FunctionArg": [
{
"ArgName": "domain_name",
"ArgValue": "developer.aliyundoc.com"
}
]
}
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 |
|---|---|---|
| 400 | Invalid%s.ValueNotSupported | FunctionName [%s] is not supported. |
| 404 | InvalidUser | The user's account is invalid. |
訪問錯誤中心查看更多錯誤碼。