查詢多條HTTPS應用配置。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
esa:ListHttpsApplicationConfigurations |
list |
*Site
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| SiteId |
integer |
是 |
網站 ID,可通過調用 ListSites 介面擷取。 |
123456**** |
| ConfigId |
integer |
否 |
配置 ID。 |
3528160969**** |
| ConfigType |
string |
否 |
配置類型,可以根據此參數查全域配置或者規則配置,取值範圍:
該參數可以不傳,不傳時不區分全域或者規則配置。 |
global |
| RuleName |
string |
否 |
規則名,可以查出規則名為所傳欄位的那條規則。 |
rule_example |
| PageNumber |
integer |
否 |
第幾頁,不傳時預設為 1。 |
1 |
| PageSize |
integer |
否 |
每頁幾條,最大 500,不傳時預設 500。 |
20 |
| SiteVersion |
integer |
否 |
網站的版本號碼。開啟了版本管理的網站,可以通過該參數指定配置生效的網站版本,預設為版本 0。 |
1 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
0AEDAF20-4DDF-4165-8750-47FF9C1929C9 |
| Configs |
array<object> |
返回體配置。 |
|
|
object |
|||
| ConfigId |
integer |
配置 ID。 |
395386449776640 |
| SiteVersion |
integer |
網站配置的版本號碼。開啟了配置版本管理的網站,可以通過該參數指定配置生效的網站版本,預設為版本 0。 |
1 |
| Sequence |
integer |
規則執行順序。數值越小越優先執行。 |
1 |
| RuleEnable |
string |
規則開關。添加全域配置的時候不需要設定該參數。取值範圍:
|
on |
| Rule |
string |
規則內容,使用條件運算式來匹配使用者請求。添加全域配置的時候不需要設定該參數。存在兩種使用情境:
|
(http.host eq \"video.example.com\") |
| RuleName |
string |
規則名稱。添加全域配置的時候不需要設定該參數。 |
rule_example |
| ConfigType |
string |
配置類型,可以根據此參數查全域配置或者規則配置,取值範圍:
|
global |
| HttpsForce |
string |
是否開啟強制 HTTPS,預設關閉。取值範圍:
|
on |
| HttpsForceCode |
string |
強制 HTTPS 跳轉狀態代碼,取值範圍:
|
301 |
| AltSvc |
string |
Alt-Svc 功能開關,預設關閉。取值範圍:
|
on |
| AltSvcClear |
string |
Alt-Svc 頭是否包含 clear 參數,預設關閉。取值:
|
on |
| AltSvcPersist |
string |
Alt-Svc 頭包是否含 persist 參數,預設關閉。取值:
|
on |
| AltSvcMa |
string |
Alt-Svc 有效時間,單位是秒,預設為 86400 秒。 |
86400 |
| Hsts |
string |
是否開啟 HSTS,預設關閉。取值範圍:
|
on |
| HstsMaxAge |
string |
HSTS 到期時間,單位是秒。 |
3600 |
| HstsIncludeSubdomains |
string |
是否在 HSTS 中包括子域,預設關閉。取值範圍:
|
on |
| HstsPreload |
string |
是否開啟 HSTS 預先載入,預設關閉。取值範圍:
|
on |
| HttpsSniVerify |
string |
是否開啟 SNI 校正,預設關閉。取值範圍:
|
on |
| HttpsNoSniDeny |
string |
是否開啟拒絕無 SNI 的 TLS 握手請求,預設關閉。取值範圍:
|
on |
| HttpsSniWhitelist |
string |
指定允許的 SNI 白名單列表,多個以空格分隔。 |
abc edf |
| PageNumber |
integer |
當前頁碼。 |
1 |
| PageSize |
integer |
分頁大小。 |
10 |
| TotalCount |
integer |
記錄總數。 |
16 |
| TotalPage |
integer |
總頁數。 |
2 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
"Configs": [
{
"ConfigId": 395386449776640,
"SiteVersion": 1,
"Sequence": 1,
"RuleEnable": "on",
"Rule": "(http.host eq \\\"video.example.com\\\")\n",
"RuleName": "rule_example",
"ConfigType": "global",
"HttpsForce": "on",
"HttpsForceCode": "301",
"AltSvc": "on",
"AltSvcClear": "on",
"AltSvcPersist": "on",
"AltSvcMa": "86400",
"Hsts": "on",
"HstsMaxAge": "3600",
"HstsIncludeSubdomains": "on",
"HstsPreload": "on",
"HttpsSniVerify": "on",
"HttpsNoSniDeny": "on",
"HttpsSniWhitelist": "abc edf"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 16,
"TotalPage": 2
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 調用服務失敗,請稍後重試或聯絡客服諮詢詳情。 |
| 400 | InvalidParameter.FunctionName | The specified feature does not exist. Specify a valid feature name based on the related documentation. | 您所輸入的功能名稱不存在,請參照功能配置文檔選擇正確的功能名進行操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。