調用BatchSetCdnDomainConfig進行網域名稱大量設定。
- 單使用者調用頻率為30次/秒。
- 單次配置的網域名稱數量不超過50個。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchSetCdnDomainConfig |
系統規定參數。取值:BatchSetCdnDomainConfig。 |
DomainNames | String | 是 | example.com |
加速網域名稱,多個網域名稱用半形逗號(,)分隔。 |
Functions | String | 是 | [{"functionArgs":[{"argName":"domain_name","argValue":"api.hellodtworld.com"}],"functionName":"set_req_host_header"}] |
功能列表,格式如下:
多個參數之間用半形逗號(,)分隔。 |
部分功能可以設定多條記錄,例如filetype_based_ttl_set,當需要更新其中某條記錄時,可通過該條記錄的configId來指定。
[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"}],"functionName":"filetype_based_ttl_set","configId":5068995}]
功能說明:所有參數值均按照字串類型處理。
名稱 |
參數 |
---|---|
referer_white_list_set:Referer白名單 |
refer_domain_allow_list:白名單列表,多個用半形逗號(,)分隔。 allow_empty:是否允許空Referer欄位訪問CDN資源,取值:on或off。 |
referer_black_list_set:Referer黑名單 |
refer_domain_deny_list:黑名單列表,多個用半形逗號(,)分隔。 allow_empty:是否允許空Referer欄位訪問CDN資源,取值:on或off。 |
filetype_based_ttl_set:檔案到期時間設定 |
ttl:緩衝時間,單位為秒。 file_type:檔案類型。多個檔案類型用半形逗號(,)分隔,例如TXT,JPG。 weight:權重。最大為99,最小為1,數字越大優先順序越高。 |
path_based_ttl_set:目錄到期時間設定 |
ttl:緩衝時間,單位為秒。 path:目錄,必須以正斜線(/)開頭。 weight:權重。最大為99,最小為1,數字越大優先順序越高。 |
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:Taobao Missile Defense免攔截 |
ip_list:IP列表,多個用半形逗號(,)分隔。 |
error_page:錯誤頁面重新導向 |
error_code:錯誤碼。 rewrite_page:重新導向頁面。 |
set_req_host_header:修改回源自訂頭 |
domain_name:回源HOST頭內容。 |
set_hashkey_args:保留URL參數 |
hashkey_args:保留參數列表,多個用半形逗號(,)分隔,最多支援填寫10個。 disable:等於on,表示忽略所有參數,off表示不忽略(緩衝hashkey忽略所有參數,優先順序低於保留緩衝參數列表功能)。 keep_oss_args:等於on,表示回源保留所有參數,off表示與緩衝hashkey的參數一致。 |
aliauth:阿里鑒權 |
auth_type:鑒權類型。取值範圍:no_auth(無鑒權)、type_a(鑒權方式A)、type_b(鑒權方式B)和type_c(鑒權方式C)。 auth_key1:鑒權key1(16~32個字元支援大寫字母、小寫字母和數字)。 auth_key2:鑒權key2(16~32個字元支援大寫字母、小寫字母和數字) ali_auth_delta:自訂鑒權緩衝時間。 |
set_resp_header:設定回應標頭(瀏覽器端可見) |
key(必填):回應標頭。 value(必填):回應標頭內容,刪除填寫null。 header_operation_type:要求標頭操作,支援add、delete、modify和rewrite。add:添加,delete:刪除,modify:變更,rewrite:替換。 duplicate:是否允許重複,取值:on或off。 header_source:尋找。 header_destination:替換。 match_all:匹配所有,取值:on或off。 |
https_force:強制HTTPS跳轉 |
enable:功能開關,取值:on或off。 |
http_force:強制HTTP跳轉 |
enable:功能開關,取值:on或off。 |
https_option:HTTPS基礎參數 |
http2:HTTP2開關,取值:on或off。 ocsp_stapling:OCSP Stapling開關,取值:on或off。 |
forward_scheme:靜態協議跟隨回源 |
enable:開關,取值:on或off。 scheme_origin:回源協議類型,支援http、https和follow(跟隨)。 |
tmd_signature:頻次控制自訂規則 |
name:規則名稱,網域名稱內不可重複。 path:可重複,需校正uri路徑合法性。 pathType:匹配規則,0 首碼匹配,1 完全符合。 interval:監測時間長度,單位秒,參數限制必須>=10。 count:單IP訪問次數。 action:阻斷類型,0 封鎖,1 人機識別。 ttl:阻斷時間長度,單位秒。 object:攔截對象。 rule:攔截規則。 |
dynamic:全站加速相關配置 |
enable:必填,開關,支援on或off。 static_route_type:靜態加速檔案尾碼。 static_route_url:靜態加速URI。 static_route_path:靜態加速PATH。 dynamic_route_origin:回源路由 scheme,支援http、https或follow。 dynamic_route_round_robin:開啟負載平衡開關,支援on或off。 dynamic_route_adapt_cache:開啟自適應緩衝開關,支援on或off。 |
set_req_header:自訂回源HTTP頭 |
key:回源頭。 value:回源頭內容。 |
l2_oss_key:私人buckct回源 |
private_oss_auth:私人Bucket回源開關,支援on或off。 |
range:range回源 |
enable:開關,支援on、off、force(強制)。 |
video_seek:視頻拖拽播放 |
enable(必填):開關,支援on或off。 flv_seek_by_time:開啟FLV按時間拖拽,支援on或off。 mp4_seek_start:自訂MP4開始參數。 mp4_seek_end:自訂MP4結束參數。 flv_seek_start:自訂FLV開始參數。 flv_seek_end:自訂FLV結束參數。 |
ali_remove_args:忽略URL參數(刪除) |
ali_remove_args(必填):刪除指定的參數,多個參數之間用空格隔開,剩餘參數將作為hashkey中URL args部分。 keep_oss_args:回源保留參數。支援on或off,on表示回源保留所有參數,off表示與緩衝hashkey的參數一致。 |
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 預設:off,支援on或off。 |
HSTS:HSTS |
enabled(必填):開關,預設為off,支援on或off。 https_hsts_max_age(必填):到期時間,單位:s,建議填寫5184000s(60天)。 https_hsts_include_subdomains: HSTS頭包含includeSubDomains參數,支援on或off。請謹慎開啟,開啟前請確保該加速網域名稱的所有子網域名稱都已開啟HTTPS,否則會導致子網域名稱自動跳轉到HTTPS後無法訪問。 |
filetype_force_ttl_code:檔案狀態代碼到期時間設定 |
file_type(必填):檔案類型,多個用半形逗號(,)分隔,例如:TXT,JPG。 code_string(必填):狀態代碼,多個用半形逗號(,)分隔。例如:302=0,301=0,4xx=2。 |
path_force_ttl_code:路徑狀態代碼到期時間設定 |
path(必填):必須以正斜線(/)開頭,例如:/image。 code_string(必填):狀態代碼,多個用半形逗號(,)分隔。例如:302=0,301=0,4xx=2。 |
gzip:頁面Gzip最佳化 |
enable(必填):功能開關,支援on或off。 |
tesla:頁面最佳化加速 |
enable(必填):功能開關,支援on或off。 trim_js:支援on或off,開啟該功能,最佳化html中內嵌的js代碼。 trim_css:支援on或off,開啟該功能,最佳化html中內嵌的css代碼。 |
https_origin_sni:回源SNI |
enabled(必填):功能開關,支援on或off。 https_origin_sni(必填):回源SNI。 |
limit_rate:單請求限速 |
ali_limit_rate(必填):預設限速,限速多少(例如200k、1m等),單位Byte/s。 ali_limit_rate_after:不限速大小,在發送了多少資料之後限速,單位Byte。 traffic_limit_arg:限速參數名稱,根據URL中提取的arg進行限速,例如:rate。 traffic_limit_unit:限速參數單位,支援m、k、g,當rate=1,則限速1m或1k或1g。 ali_limit_start_hour:限速開始時間,取值範圍[0,24],小於限速結束時間,預設值為0。 ali_limit_end_hour:限速結束時間,取值範圍[0,24],大於限速開始時間,預設值為24。 |
brotli:頁面Brotli壓縮 |
enable(必填):功能開關,支援on或off。 brotli_level:壓縮等級,取值範圍[1,11]。 |
ali_ua:User-Agent限制訪問 |
ua:User-Agent。 type:名單類型,black或white。 |
set_l2_req_header:修改L2回源自訂頭 |
set_l2_req_header是v1版本,建議您使用v2版本:origin_request_header,功能更豐富。 key:回源頭。 value:回源頭內容,刪除頭請填寫null。 |
host_redirect:rewrite功能 |
regex:需要重寫的URL,例如:^/$。 replacement:目標URL,例如: /go/act/sale/tbzlsy.php。 flag:僅支援redirect、break。 |
quic:QUIC基礎參數 |
quic_enable:quic開關,支援on或off。 |
forward_timeout:回源請求逾時時間 |
forward_timeout:單位為秒,配置時建議不要大於100秒。 |
ali_video_split:音視頻分離 |
enabled:開關,支援on或off。 |
ipv6:ipv6配置 |
switch(必填):開關,支援on或off,on表示開啟,off表示關閉。 region:開啟IPv6功能的地區,支援星號(*)。 |
ali_video_preview:視頻試看 |
enable(必填):開關,支援on或off,支援TS、MP3檔案格式,FLV和MP4使用拖拽功能實現。 ali_video_preview_argument(必填):自訂試看參數名,試看參數值的單位必須是秒。 |
default_ttl_code:狀態代碼緩衝時間 |
default_ttl_code(必填):狀態代碼預設緩衝時間,單位為秒,例如:4xx=3,200=3600,5xx=1,多個使用半形逗號(,)分隔。 |
edge_function:邊緣函數 |
必填參數: rule:DSL規則。 pri:優先順序。 enable:本條規則是否生效,取值範圍on或off。 選擇性參數: name:規則名稱,僅支援英文字母和底線(_)。 pos:規則執行位置。 brk:命中本條規則後,當前執行位置剩餘規則均跳過。 option:option管控。 grammar:grammar管控,取值範圍:空、es2、js。 jsmode:js網域名稱白單管控,取值範圍:redirect、bypass。 |
follow_302:302跟隨 |
enable(必填):開關,支援on或off。 max_tries:回源次數上限,其預設值為2,可配置範圍是1~6(回源次數-1=302跟隨次數)。 retain_args:支援on/off,302跟隨時保留原請求參數回目標源,預設:不保留。 retain_header:支援on/off,302跟隨時保留原要求標頭回目標源,預設:不保留。 |
aws_s3_bucket:AWS s3鑒權bucket |
enabled(必填):開關,支援l2或off。 bucketname:Amazon S3 bucket名稱。 accesskey(必填):AWS AccessKey。 secretkey(必填):AWS SecretKey。 region(必填):Amazon S3儲存地區。 |
origin_certificate_verification:回源認證校正 |
enabled(必填):開關,支援on或off,開啟表示開啟回源認證校正,否則關閉。 common_name_whitelist:表示認證白名單列表,匹配了這些白名單的認證可以通過校正。 |
origin_dns_host:設定回源域來源站點 |
ali_origin_dns_host(必填):回源查詢DNS使用的網域名稱。 |
cc_defense:設定頻次控制自訂規則順序 |
tmdRules:自訂規則順序,多個順序使用半形逗號(,)隔開。 |
cc_rule:設定頻次控制功能 |
enabled(必填):開關,支援on或off。 template(必填):模版,支援normal(正常)、attack(攻擊)和none(無)。 argCheck(必填):參數檢測,支援on或off。 |
back_to_origin_argument_rewrite:回源參數改寫 |
優先順序:添加參數>刪除參數>僅保留參數>修改參數。多個參數用空格分隔。 delete_argument:刪除參數列表。 save_argument:保留參數列表。僅保留列出的參數,添加參數和刪除參數仍會生效。 ignore_all_argument:支援on或off,忽略所有參數,回源的時候將會刪除所有參數,但是通過添加參數功能添加的參數仍然能夠生效。 add_argument:添加參數,優先順序最高。 modify_argument:修改參數,優先順序最低,若參數被刪除則不會保留。 enable:開關,支援on或off。 |
back_to_origin_url_rewrite:回源URL改寫 |
source_url(必填):需要被重寫的URL。 target_url(必填):重寫的目標URL。 flag:改寫操作的執行規則,僅支援:空、break、enhance_break。空:執行完該條規則後,後續rewrite規則會繼續執行;break:執行完該條規則後,後續rewrite規則不再執行;enhance_break:類似break,區別在於會帶著參數一起進行處理,並且針對flv直播也會生效。 |
self_defined_cachekey:自訂Cachekey |
uri:URL。 args:參數操作。 headers:HTTP Header。 variable:自訂變數。 |
advanced_origin:進階回源Bullet |
variable_type(必填):變數類型,支援header、arg、uri、cookie。 variable(必填):變數。 conditions(必填):條件,“==”或者“!=”。 value(必填):值。 origin(必填):回源查詢DNS使用的網域名稱。 |
origin_request_header:回源HTTP要求標頭 |
header_operation_type(必填):要求標頭操作,支援add、delete、modify和rewrite,add:添加,delete:刪除,modify:變更,rewrite:替換。 header_name(必填):要求標頭名稱。 header_value:要求標頭值。 duplicate:是否允許重複,取值on或off。 header_source:尋找。 header_destination:替換。 match_all:匹配所有,支援on或off。 |
origin_response_header:回源HTTP回應標頭 |
header_operation_type(必填):回應標頭操作,支援add、delete、modify和rewrite,add:添加,delete:刪除,modify:變更,rewrite:替換。 header_name(必填):回應標頭名稱。 header_value:回應標頭值。 duplicate:是否允許重複,取值on或off。 header_source:尋找。 header_destination:替換。 match_all:匹配所有,支援on或off。 |
origin_dns_host:設定回源域來源站點 |
ali_origin_dns_host(必填):回源查詢DNS使用的網域名稱。 |
ddos_domain:DDoS防護調度 |
enable(必填):開關,支援on或off。 args:參數操作。 dispatch_target(必填):聯動目標。 attack_dispatch_partner(必填)。 dispatch_target_type(必填):聯動目標類型,支援IP或cname。 dispatch_qps:中國內地防護QPS閾值。 |
ali_location:地區封鎖 |
ali_origin_dns_host(必填):回源查詢DNS使用的網域名稱。 |
hls_token_rewrite:M3U8標準加密改寫 |
enable(必填):開關,支援on或off。 hls_token_arg_name:追加參數名稱。如果不設定,使用MtsHlsUriToken作為追加的參數名。 |
cdn_remote_auth:遠程鑒權 |
enable(必填):開關,支援on或off。 remote_auth_addr(必填):鑒權伺服器位址。格式:<props>https://cdn.aliyun.com/auth 或者<props>http://123.123.123.123/auth。 remote_auth_method(必填):要求方法,支援get/post/head。 remote_auth_type(必填):鑒權檔案類型。all表示所有類型,多個檔案類型用豎線分隔、區分大小寫,jpg和JPG是不一樣的。 remote_auth_reserve_args(必填):保留參數設定,all表示保留所有參數,多個參數用豎線分隔、ali_delete_all_args表示刪除所有URL參數、區分大小寫,key跟KEY是不一樣的。 remote_auth_custom_args(非必填):添加自訂參數,多個參數用豎線分隔、區分大小寫,key跟KEY是不一樣的。 remote_auth_reserve_header(必填):保留要求標頭設定,all表示保留所有要求標頭,多個要求標頭用豎線分隔、ali_delete_all_headers表示刪除所有要求標頭參數、不區分大小寫,http_remote_addr跟HTTP_Remote_Addr一樣。 remote_auth_custom_header(非必填):添加自訂要求標頭,多個要求標頭用豎線分隔、不區分大小寫,http_remote_addr跟HTTP_Remote_Addr一樣。 remote_auth_success_code(必填):鑒權成功狀態代碼。例如:200,鑒權伺服器傳給CDN的鑒權結果。 remote_auth_fail_code(必填):鑒權失敗狀態代碼。例如:403,鑒權伺服器傳給CDN的鑒權結果。 remote_auth_fail_resp_code(必填):鑒權失敗CDN響應狀態代碼。例如:403,CDN傳給使用者的狀態代碼。 remote_auth_timeout(必填):鑒權逾時配置,單位ms。例如:500,單位ms,允許設定最大3000。 remote_auth_timeout_action(必填):鑒權逾時行為,支援pass/reject、鑒權逾時的情況下,如果配置為pass,CDN將直接放過使用者請求;如果配置為reject,CDN將響應上面配置的“鑒權失敗CDN響應狀態代碼”給您。 |
image_transform:CDN圖片轉換 |
enable(必填):開關,支援on或off。 filetype(必填):支援轉碼的圖片格式,以豎線分割符號分隔。 webp:自適應轉換webp開關,支援on或off,判斷用戶端支援webp格式,並轉換格式為webp,為您節省流量。 orient:圖片自旋轉開關,支援on或off,只對有自旋轉屬性的圖片生效。 slim:圖片瘦身,在不改變解析度、尺寸、格式的前提下,縮小圖片品質達到省流目的。 |
allowed_crawlers:合法爬蟲 |
enable(必填):開關,支援on或off。 search_engines_ip:搜尋引擎IP,支援observer、allow和off。 |
threat_intelligence:威脅情報 |
enable(必填):開關,支援on或off。 malicious_machine_fingerprint_high:惡意高危指紋,支援observer、block和off。 malicious_machine_fingerprint_medium:惡意中危指紋,支援observer、block和off。 malicious_machine_fingerprint_normal:惡意普通指紋,支援observer、block和off。 malicious_crawler_ip:惡意爬蟲IP,支援observer、block和off。 malicious_proxy_ip:惡意代理IP,支援observer、block和off。 |
intelligent_algorithm:AI智能防護 |
enable(必填):開關,支援on或off。 fingerprint_intelligent_algorithm:指紋智能演算法,支援observer、block和off。 |
edgeroutine:邊緣程式 |
enable(必填):開關,支援on或off。 edge_routine_id(必填):程式ID,字元範圍為a-z或者0-9或者中劃線。 edge_routine_mode:觸發模式,支援redirect或bypass,預設為redirect。 edge_routine_fallback_cdn:CDN兜底,支援on或off,預設關閉。 |
origin_host:設定回源域Host |
origin(必填):來源站點。 host(必填):host。 |
condition:進階條件2.0 |
rule(必填):條件內容。 name:條件名稱。 |
ali_origin_port_scheme:設定回源連接埠和協議 |
port(必填):回源連接埠,當scheme為follow時,需填寫為 scheme(必填):回源協議,支援follow、http、https。 |
origin_sni:設定回源域SNI |
origin(必填):來源站點。 sni_host(必填):SNI host。 keepalive_sni(非必填):長串連SNI匹配,開啟後,不同回源SNI將使用不同長串連,支援on或off。 |
返回資料
名稱 | 類型 | 樣本值 | 描述 |
---|---|---|---|
DomainConfigList | Array of DomainConfigModel |
網域名稱配置ID列表。 |
|
DomainConfigModel | |||
ConfigId | Long | 1234567 |
配置ID。 |
DomainName | String | www.example.com |
網域名稱。 |
FunctionName | String | set_req_host_header |
功能。 |
RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE73368 |
請求ID。 |
樣本
請求樣本
http://cdn.aliyuncs.com/?Action=BatchSetCdnDomainConfig
&DomainName=example.com,example.org
&Functions=[{"functionArgs":[{"argName":"domain_name","argValue":"api.hellodtworld.com"}],"functionName":"set_req_host_header"}]
&<公用請求參數>
正常返回樣本
XML
格式
<BatchSetCdnDomainConfigResponse>
<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
<DomainConfigModel>
<DomainName>www.example.com</DomainName>
<ConfigId>1234567</ConfigId>
<FunctionName>set_req_host_header</FunctionName>
</DomainConfigModel>
</BatchSetCdnDomainConfigResponse>
JSON
格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"DomainConfigModel": [
{
"DomainName": "www.example.com",
"ConfigId": 1234567,
"FunctionName": "set_req_host_header"
}
]
}
錯誤碼
HttpCode | 錯誤碼 | 錯誤資訊 | 描述 |
---|---|---|---|
400 | InvalidFunctions.Malformed | The specified Functions is incorrectly formatted. | 配置格式錯誤。 |
400 | InvalidArgValue.Malformed | The specified ArgValue is invalid. | 參數格式錯誤,請檢查更新後重試。 |
400 | MissingParameter%s | The specified value of ArgName[%s] is missing. | 參數不可為空。 |
400 | InvalidFunctionArgs.Malformed | The specified FunctionArgs is invalid. | 指定的功能參數是錯誤的。 |
400 | InvalidHeaderKey.ValueNotSupported | The specified value of parameter HeaderKey is not supported. | 指定的HTTP頭參數不合法,超出可選範圍。取值: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,Access-Control-Allow-Credentials。 |
400 | ConfigurationConflicts | The staging environment has a configuration in effect and cannot modify the production environment configuration. | 現在類比環境的配置和生產環境配置不一致,無法直接修改生產環境配置。請您前往類比環境完成您所需的配置,然後發布到生產環境進行覆蓋。 |
400 | NoPermission.SLR | The current user does not have permission to create servicelinkedrole. Please contact the Alibaba Cloud account or administrator to authorize AliyunCDNFullAccess or custom policy:Service Name:cdn-ddos.cdn.aliyuncs.com,Role: AliyunServiceRoleForCDNAccessingDDoS,Permission: ram: CreateServiceLinkedRole | 目前使用者沒有建立服務關聯角色的許可權,請聯絡主帳號或許可權管理員授權AliyunCDNFullAccess或授權建立服務關聯角色的自訂權限原則。自訂權限原則的相關資訊如下:Service Name:cdn-ddos.cdn.aliyuncs.com服務關聯角色名稱:AliyunServiceRoleForCDNAccessingDDoS執行該操作所需的使用者權限:ram:CreateServiceLinkedRole |
訪問錯誤中心查看更多錯誤碼。