域名批量配置。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vs:BatchSetVsDomainConfigs |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainNames | string | 是 | 您的加速域名。 說明
支持多個,用英文逗號(,)分隔。
| example.aliyundoc.com |
Functions | string | 是 | 功能列表。 | [{“functionArgs”:[{“argName”:”domain_name”,”argValue”:”api.hellodtworld.com”}],”functionName”:”set_req_host_header”}] |
Functions 格式
-
[{“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”},{“argName”:”weight”,”argValue”:”30”}],”functionName”:”filetype_based_ttl_set”,”configId”:5068995}]
功能說明
所有參數值均按照字符串類型處理。
名稱 | 參數 |
---|---|
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:文件類型。支持多個,用(英文)逗號隔開,如:txt,jpg; weight:權重。取值范圍:1~199 |
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 免攔截 | ip_list:IP 列表。多個用逗號(英文)隔開 |
error_page:錯誤頁面重定向 | error_code:錯誤碼; rewrite_page:重定向頁面 |
set_req_host_header:修改回源自定義頭 | domain_name:回源 Host 頭內容 |
set_hashkey_args:忽略 URL 參數 | hashkey_args:保留參數的列表。多個用逗號(英文)分隔; disable:disable 等于 on 的時候表示忽略所有參數,off 不忽略 |
aliauth:阿里鑒權 | auth_type:鑒權類型,取值范圍:”no_auth”,”type_a”,”type_b”,”type_c”; auth_key1:鑒權 key1; auth_key2:鑒權 key2; ali_auth_delta:自定義鑒權緩沖時間 |
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 |
http_force:強制 HTTP 跳轉 | enable:功能開關,取值范圍:on/off |
https_option:HTTPS 基礎參數 | http2:http2 開關,取值范圍:on/off |
l2_oss_key:L2 OSS 回源私鑰 | private_oss_auth:是否開啟私有 OSS 鑒權功能,取值范圍:on/off |
forward_scheme:靜態協議跟隨回源 | enable:開關,取值范圍:on/off; scheme_origin:回源站協議,支持 http、https 和 follow |
green_manager 鑒黃功能 | enable:是否開啟鑒黃功能,取值范圍:on/off |
tmd_signature:配置頻次控制自定義規則 | name:規則名稱,域名內不可重復; path:可重復,需校驗 URI 路徑合法性; pathType:匹配規則。0:前綴匹配,1:完全匹配; interval:監測時長,單位秒,參數限制必須>=10; count:單 IP 訪問次數; action:阻斷類型。0:封禁,1:人機識別; ttl:阻斷時長,單位:秒; |
dynamic:全站加速相關配置 | enable:開關(必填)。支持 on/off; static_route_type:靜態加速文件后綴 static_route_url:靜態加速 URI; static_route_path:靜態加速 PATH; dynamic_route_origin:回源路由 scheme,支持 http/https/follow; |
set_req_header:自定義回源 HTTP 頭 | key:回源頭; value:回源頭內容 |
l2_oss_key:私有 Bucket 回源 | private_oss_auth:私有 Bucket 回源開關,支持 on/off |
range:range 回源 | enable:開關,支持 on/off/force |
video_seek:視頻拖拽播放 | enable:開關,支持 on/off |
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 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "9BEC5E85-C76B-56EF-A922-860EFDB8B64B"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
特殊錯誤碼
錯誤代碼 | 描述 | HTTP 狀態碼 | 語義 |
---|---|---|---|
InvalidFunctions.Malformed | Specified Functions is malformed. | 400 | 指定的 Functions 不合法。 |
InvalidFunctionName.ValueNotSupported | FunctionName %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 不合法。 |