調用DescribeDcdnDomainConfigs擷取加速網域名稱的配置資訊。
介面說明
一次可查詢多個功能配置資訊。
單使用者調用頻率:30 次/秒。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dcdn:DescribeDcdnDomainConfigs |
get |
domain
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DomainName |
string |
是 |
加速網域名稱,僅支援查詢單個網域名稱。 |
example.com |
| FunctionNames |
string |
否 |
功能列表名稱,多個用英文逗號(,)分隔。 |
filetype_based_ttl_set,set_req_host_header |
| ConfigId |
string |
否 |
配置 ID。 |
5003576 |
功能列表如下表所示。
| 名稱 | 參數 |
| referer_white_list_set:Referer 防盜鏈白名單 | refer_domain_allow_list:白名單列表,多個用英文逗號(,)分隔。 allow_empty:是否允許空 Referer 欄位訪問 DCDN 資源,取值:on 或 off。 |
| referer_black_list_set:Referer 防盜鏈黑名單 | refer_domain_deny_list:黑名單列表,多個用英文逗號(,)分隔。 allow_empty:是否允許空 Referer 欄位訪問 DCDN 資源,取值:on 或 off。 |
| filetype_based_ttl_set:檔案類型緩衝到期時間設定 | ttl:緩衝時間,單位為秒。 file_type:檔案類型。多個檔案類型用英文逗號(,)分隔,例如 TXT,JPG。 weight:權重。 |
| path_based_ttl_set:目錄類型緩衝到期時間設定 | ttl:緩衝時間,單位為秒。 path:目錄,必須以正斜線(/)開頭。 weight:權重。 |
| oss_auth:OSS 鑒權 Bucket | oss_bucket_id:您的 Bucket 地址。 |
| ip_black_list_set:IP 黑名單 | ip_list:IP 列表,多個用英文逗號(,)分隔。 |
| ip_allow_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:保留參數列表,多個用英文逗號(,)分隔,最多支援填寫 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;auth_key2:鑒權 key2。 ali_auth_delta:自訂鑒權緩衝時間。 |
| set_resp_header:設定 HTTP 回應標頭(瀏覽器端可見) | 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(跟隨)。 |
| dynamic:全站加速相關配置 | enable(必填):開關,支援 on 或 off。 static_route_type:靜態加速檔案尾碼。 static_route_url:靜態加速 URI。 static_route_path:靜態加速 PATH。 dynamic_route_origin:回源路由 scheme,支援 http、https、follow 和 follow-port。 dynamic_route_round_robin:開啟負載平衡開關,支援 on 或 off。 dynamic_route_adapt_cache:開啟自適應緩衝開關,支援 on 或 off。 |
| set_req_header:自訂回源 HTTP 頭 | key:回源頭。 value:回源頭內容。 |
| l2_oss_key:阿里雲 OSS 私人 Bucket 回源 | private_oss_auth:私人 Bucket 回源開關,支援 on 或 off。 |
| range:range 回源 | enable:開關,支援 on、off。 |
| 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 結束參數。 |
| websocket:Websocket | enabled(必填):是否開啟,取值:on 或 off。 origin_scheme:回源 scheme,支援 http、https 和 follow。 heartbeat:心跳時間,預設為 60 秒,支援 1~300 秒。 |
| 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(必填):到期時間,單位:ms,建議填寫 5184000000ms(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:智能壓縮 | 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。 |
| protogw:IP 應用加速 | realip(必填):來源站點 IP 透傳方式,支援 off、toa、pp。 port(必填):服務連接埠。 patten:模式字串。 |
| host_redirect:重寫功能 | regex:需要重寫的 URL,例如:^/$。 replacement:目標 URL,例如: /go/act/sale/tbzlsy.php。 flag:僅支援 redirect、break。 |
| forward_timeout:回源請求逾時時間 | forward_timeout:單位為秒,配置時建議不要大於 100 秒。 |
| ipv6:IPv6 配置 | switch(必填):開關,支援 on 或 off,on 表示開啟,off 表示關閉。 region:開啟 IPv6 功能的地區,支援星號(*)。 |
| edge_function:邊緣指令碼 | rule(必填):DSL 規則。 pri(必填):優先順序。 enable(必填):本條規則是否生效,取值:on 或 off。 name:規則名稱。 pos:規則執行位置。全站加速網域名稱僅支援 head,不支援 foot。 brk:命中本條規則後,當前執行位置剩餘規則均跳過。 option:option 管控。 grammar:grammar 管控,可選值:空、es2、js。 jsmode:js 網域名稱白單管控,可選值:redirect、bypass。 |
| brotli:Brotli 壓縮 | enable(必填):功能開關,支援 on 或 off。 brotli_level:壓縮等級,取值範圍[1,11]。 |
| ali_ua:User-Agent 黑/白名單 | ua:User-Agent。 type:名單類型,black 或 white。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED |
| DomainConfigs |
object |
||
| DomainConfig |
array<object> |
網域名稱配置。 |
|
|
object |
|||
| Status |
string |
狀態。取值:
|
success |
| ParentId |
string |
進階條件配置 ID。 |
1234567 |
| ConfigId |
string |
配置 ID。 |
5068995 |
| FunctionName |
string |
功能名稱。 |
set_req_host_header |
| FunctionArgs |
object |
||
| FunctionArg |
array<object> |
功能配置。 |
|
|
object |
|||
| ArgName |
string |
配置名稱。 |
ttl |
| ArgValue |
string |
配置值。 |
13 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
"DomainConfigs": {
"DomainConfig": [
{
"Status": "success",
"ParentId": "1234567",
"ConfigId": "5068995",
"FunctionName": "set_req_host_header",
"FunctionArgs": {
"FunctionArg": [
{
"ArgName": "ttl",
"ArgValue": "13"
}
]
}
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Invalid%s.ValueNotSupported | FunctionName [%s] is not supported. | 不支援該配置,請重新查詢。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。