批量刪除域名配置
調(diào)用BatchDeleteLiveDomainConfigs批量刪除域名配置。
使用說明
先獲取需要刪除配置的直播域名,再調(diào)用本接口批量刪除域名配置。
QPS限制
本接口的單用戶QPS限制為30次/秒。超過限制,API調(diào)用會被限流,這可能會影響您的業(yè)務(wù),請合理調(diào)用。更多信息,請參見QPS限制。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | BatchDeleteLiveDomainConfigs | 系統(tǒng)規(guī)定參數(shù)。取值:BatchDeleteLiveDomainConfigs。 |
DomainNames | String | 是 | demo.aliyundoc.com,example.aliyundoc.com,example.com | 您的推流域名或播流域名。多個域名使用英文逗號(,)分隔。 |
FunctionNames | String | 是 | referer_white_list_set,ip_black_list_set | 功能列表名稱。多個功能使用英文逗號(,)分隔。更多詳情,請參考下表Functions功能說明。 |
Functions格式說明
- 示例如下所示:
[{"functionArgs":[{"argName":"domain_name","argValue":"developer.aliyundoc.com"}],"functionName":"set_req_host_header"}]
- 某些功能,如filetype_based_ttl_set,可以設(shè)置多條記錄,當(dāng)需要更新其中某條記錄時,可通過該條記錄的configId來指定,示例如下所示:
[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]
Functions功能說明
名稱 |
參數(shù) |
referer_white_list_set:refer白名單。 |
refer_domain_allow_list:白名單列表,多個使用英文逗號(,)分隔。 allow_empty:是否允許空refer進(jìn)入。取值:on或off。 |
referer_black_list_set:refer黑名單。 |
refer_domain_deny_list:黑名單列表,多個使用英文逗號(,)分隔。 allow_empty:是否允許空refer進(jìn)入。取值:on或off。 |
filetype_based_ttl_set:文件過期時間設(shè)置。 |
ttl:cache時間。單位:秒,取值范圍是1~99999999(3年多一些)。 file_type:文件類型。多個使用英文逗號(,)隔開。 weight:權(quán)重。取值范圍:1~99。 |
path_based_ttl_set:目錄過期時間設(shè)置。 |
ttl:cache時間。單位:秒,取值范圍是1~99999999(3年多一些)。 path:目錄。必須以正斜線(/)開頭。 weight:權(quán)重。取值范圍:1~99。 |
oss_auth:OSS鑒權(quán)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頭內(nèi)容。 |
set_hashkey_args:忽略url參數(shù)。 |
hashkey_args:保留參數(shù)的列表。多個使用英文逗號(,)分隔。 disable:是否忽略所有參數(shù)。取值:僅支持on(忽略所有參數(shù))或off(不忽略)。 |
aliauth:阿里鑒權(quán)。 |
auth_type:鑒權(quán)類型。取值:type_a(鑒權(quán)A)、no_auth(關(guān)閉鑒權(quán))。 auth_key1:鑒權(quán)key1,鑒權(quán)key支持大寫字母、小寫字母、數(shù)字,建議設(shè)置長度為8~32個字符。 auth_key2:鑒權(quán)key2。 ali_auth_delta:自定義鑒權(quán)緩沖時間,單位:分鐘。建議最小設(shè)置為1分鐘,無上限限制。 auth_m3u8:是否開啟m3u8內(nèi)容改寫,對m3u8里面的ts補(bǔ)齊對應(yīng)的鑒權(quán),可以避免ts的訪問鑒權(quán)失敗。取值:on(默認(rèn)值)或off。 |
remote_auth:直播遠(yuǎn)程鑒權(quán) 。 |
enable:是否開啟遠(yuǎn)程鑒權(quán),必填項。取值:on或off。 remote_auth_path : 鑒權(quán)服務(wù)器地址,必填項。 remote_auth_pattern :鑒權(quán)模式串。有以下功能可設(shè)置:
|
set_resp_header:設(shè)置響應(yīng)頭(瀏覽器端可見)。 |
key:響應(yīng)頭。取值: 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:響應(yīng)頭內(nèi)容。刪除填寫null。 |
https_force:強(qiáng)制HTTPS跳轉(zhuǎn)。 |
enable:功能開關(guān)。取值:on或off。https_force和http_force只能存在其中一個,兩者為互斥關(guān)系,配置另外一個需要先刪除原來的配置。 |
http_force:強(qiáng)制HTTP跳轉(zhuǎn)。 |
enable:功能開關(guān)。取值:on或off。https_force和http_force只能存在其中一個,兩者為互斥關(guān)系,配置另外一個需要先刪除原來的配置。 |
forward_scheme:自適應(yīng)回源。 |
enable:功能開關(guān),取值:on或off。 scheme_origin:回源站協(xié)議 (http、https、follow)。 scheme_origin_port:回源站協(xié)議端口(80、443、80:443)。 |
green_manager:鑒黃功能。 |
enable:是否開啟鑒黃功能。取值:on或off。 |
tmd_signature:自定義的訪問頻次控制規(guī)則。 |
name:規(guī)則名稱。域名內(nèi)不可重復(fù)。 path:可重復(fù),需校驗URI路徑合法性。 pathType:匹配規(guī)則。0前綴匹配,1完全匹配。 interval:監(jiān)測時長。單位:秒。參數(shù)限制必須≥10。 count:單IP訪問次數(shù)。 action:阻斷類型。0封禁,1人機(jī)識別。 ttl:阻斷時長。單位:秒。 |
l2_oss_key:L2 OSS 回源私鑰。 |
private_oss_auth:是否開啟私有OSS鑒權(quán)功能。取值:on或off。 |
video_seek:視頻切片拖拽開關(guān)。 |
enable:功能開關(guān)。取值:on或off。 |
gzip:頁面Gzip優(yōu)化 。 |
enable:功能開關(guān)。取值:on或off。 |
tesla:頁面優(yōu)化加速。 |
enable:功能開關(guān)。取值:on或off。 |
ali_ua:User-Agent限制訪問。 |
ua:User-Agent。 type:名單類型。取值black和white。 |
host_redirect:rewrite功能。 |
regex:需要重寫的URL。例如 ^/$。 replacement:目標(biāo)URL。例如 /go/act/sale/tbzlsy.php。 flag:僅支持:redirect、break。 |
ipv6:ipv6配置。 |
switch:開關(guān)(必填)。取值:on或off,開啟功能,一旦開啟后,如需關(guān)閉請取消勾選,不要刪除配置,否則不生效。 region:開啟IPv6功能的地域,取值:cn-beijing(北京)、cn-shanghai(上海)、cn-shenzhen(深圳)、cn-qingdao(青島)、apsoutheast-1(新加坡)、eu-central-1(德國)、ap-northeast-1(東京)、ap-southeast-5(雅加達(dá))。 |
ali_location:區(qū)域限制訪問。 |
location:地域列表。 type:名單類型。取值black或white。 |
cc_defense:防CC攻擊。 |
enable:開啟或關(guān)閉防CC攻擊。取值:on或off。 |
alilive:視頻直播配置。 |
notify_url:直播通知url。 enable:功能開關(guān)。取值:on或off。 live_forbid_flv:禁止播放flv。取值:on或off。 live_forbid_rtmp:禁止播放rtmp。取值:on或off。 live_forbid_hls:禁止播放hls。取值:on或off。 |
ali_grtn:grtn業(yè)務(wù)接入開關(guān)。 |
grtn_rts_pub:RTS推流開關(guān),推流域名使用。取值:on或off。 grtn_rts_play:RTS播流開關(guān),播流域名使用。取值:on或off。 grtn_rts_transcode:RTS H5播放自動轉(zhuǎn)碼開關(guān)。取值:on或off。 |
edge_function:邊緣函數(shù)。 |
必填參數(shù): rule:DSL規(guī)則。 pri:優(yōu)先級。 enable:本條規(guī)則是否生效。取值:on或off。 可選參數(shù): name:規(guī)則名稱。 pos:規(guī)則執(zhí)行位置。 brk:命中本條規(guī)則后,當(dāng)前執(zhí)行位置剩余規(guī)則均跳過。 option:option管控。 grammar:grammar管控。可選值:空、es2、js。 jsmode:js域名白單管控,可選值:redirect或bypass。 |
https_tls_version:TLS協(xié)議版本。 |
tls10:開啟TLSv1.0,默認(rèn)為on。取值:on或off。 tls11:開啟TLSv1.1,默認(rèn)為on。取值:on或off。 tls12:開啟TLSv1.2,默認(rèn)為on。取值:on或off。 tls13:開啟TLSv1.3,默認(rèn)為on。取值:on或off。 |
https_option:http協(xié)議設(shè)置。 |
http2:是否開啟http2,默認(rèn)為off。取值:on或off。 live_http2:是否開啟live_http2,默認(rèn)為off。取值:on或off。 |
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE73368 | 請求ID。 |
示例
請求示例
http(s)://live.aliyuncs.com/?Action=BatchDeleteLiveDomainConfigs
&DomainNames=demo.aliyundoc.com,example.aliyundoc.com,example.com
&FunctionNames=referer_white_list_set,ip_black_list_set
&<公共請求參數(shù)>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<BatchDeleteLiveDomainConfigsResponse>
<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</BatchDeleteLiveDomainConfigsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。