批量配置域名。
使用說明
先獲取需要進行配置的直播域名，再調用本接口批量配置域名。
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***}] | 功能列表。 某些功能，如 |
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 ：鑒權模式串。有以下功能可設置：
|
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不合法。 |