閱讀101 返回首頁    go 小米 go 小米 note

CreateLoadBalancerHTTPSListener__Listener相關API_API 參考_負載均衡-阿裏雲

描述

  • 創建HTTPS Listener，為負載均衡實例創建基於HTTPS協議的Listener，包含基於HTTPS協議的策略及健康檢查配置。注意：這裏前端和後端端口用戶可自定義。

  • 新創建的Listener為Stoped狀態，需調用StartLoadBalancerListener，使之生效。Listener的狀態轉換圖，參見附錄負載均衡 Listener狀態轉換圖

請求參數

名稱 類型 是否必須 描述
Action String 是 操作接口名，係統規定參數。
取值：CreateLoadBalancerHTTPSListener
LoadBalancerId String 是 負載均衡實例的唯一標識。
ListenerPort Integer 是 負載均衡實例前端使用的端口。
取值：1-65535
BackendServerPort Integer 是 負載均衡實例後端使用的端口。
取值：1-65535
Bandwidth Integer 是 監聽的帶寬峰值。
取值：-1 / 1-1000Mbps
針對按固定帶寬計費方式的公網類型實例，
不同Listener上的Bandwidth分配的帶寬峰值總和不能超出在創建負載均衡實例時設定的Bandwidth值，且不能將Listener上的Bandwidth設置為-1；
針對按使用流量計費方式的公網類型實例，可以選擇將Listener上的Bandwidth設置為-1，表示不限製帶寬峰值。
XForwardedFor String 否 是否開啟通過X-Forwarded-For的方式獲取來訪者真實IP。
取值：on / off
默認值：on
注：考慮安全原因，本參數自2015年5月15日起會強製設置為on，考慮的接口兼容性，本接口入參還保留。
Scheduler String 否 調度算法。
取值：wrr / wlc
默認值：wrr
StickySession String 是 是否開啟會話保持。
取值：on / off
StickySessionType String 視情況而定 cookie的處理方式。
該參數在StickySession為on時為必選；當StickySession為off時，此參數設置將被忽略。
取值：insert / server設置為insert表示由負載均衡插入，
設置為server表示負載均衡從後端服務器學習。
CookieTimeout Integer 視情況而定 cookie超時時間。
該參數在StickySession為on且StickySessionType為insert時為必選，其餘情況下該參數會被忽略。
取值： 1-86400（單位為秒）
Cookie String 視情況而定 服務器上配置的cookie。
僅在StickySession為on且StickySessionType為server時為必選；其餘情況下該參數會被忽略。
取值：遵守RFC 2965且長度為1-200的字符串。
隻能包含 ASCII 英文字母數字字符，不能包含逗號、分號或空格，也不能以 $ 字符開頭。
HealthCheck String 是 是否開啟健康檢查。
取值：on / off
HealthCheckDomain String 否 用於健康檢查的域名。
取值：$_ip 用戶自定義字符串 空
自定義字符串規則：長度限製為1-80，隻能使用字母、數字、‘-’、‘.’這些字符。
用戶設置此參數為’$_ip’或空時，負載均衡會使用各後端服務器的私網IP當做健康檢查使用的Domain。
HealthCheckURI String 視情況而定 用於健康檢查的URI。
當HealthCheck為on時，此參數為必選；當HealthCheck為off時，此參數設置將被忽略。
取值：長度限製為1-80，必須以’/’開頭。隻能使用字母、數字、‘-’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’這些字符。
HealthCheckConnectPort Integer 視情況而定 進行健康檢查時使用的端口。
當HealthCheck為on時，此參數為必選；當HealthCheck為off時，此參數設置將被忽略。
取值：1-65535，或者’-520’ 。
用戶設置此參數為’-520’時，表示使用後端服務端口（BackendServerPort）。
HealthyThreshold Integer 視情況而定 判定健康檢查結果為success的閾值。即，健康檢查連續成功多少次後，將後端服務器的健康檢查結果由fail改為success。
當HealthCheck為on時，此參數為必選；當HealthCheck為off時，此參數設置將被忽略。
取值：1-10
UnhealthyThreshold Integer 視情況而定 判定健康檢查結果為fail的閾值。即，健康檢查連續失敗多少次後，將後端服務器的健康檢查狀態由success改為fail。
當HealthCheck為on時，此參數為必選；當HealthCheck為off時，此參數設置將被忽略。
取值：1-10
HealthCheckTimeout Integer 視情況而定 每次健康檢查響應的最大超時時間。
當HealthCheck為on時，此參數為必選；當HealthCheck為off時，此參數設置將被忽略。
取值：1-50（單位為秒）
注意：如果HealthCHeckTimeout < HealthCheckInterval，則HCTimeout無效，超時時間為HealthCheckInterval。
HealthCheckInterval Integer 視情況而定 進行健康檢查的時間間隔。
當HealthCheck為on時，此參數為必選；當HealthCheck為off時，此參數設置將被忽略。
取值：1-5（單位為秒）
HealthCheckHttpCode String 視情況而定 健康檢查正常的http狀態碼，多個http狀態碼間用”,”分割。
當HealthCheck為on時，此參數為可選；當HealthCheck為off時，此參數設置將被忽略。
取值：http_2xx、http_3xx 、http_4xx 、http_5xx
默認值：http_2xx
ServerCertificateId String 是 服務器證書的ID。
CACertificateId String 否 CA證書ID，若用戶既上傳CA證書又上傳服務器證書，即采用雙向認證；若用戶隻上傳服務器證書，即為單向認證。
VServerGroupId String 否 虛擬服務器組ID
Gzip String 否 是否開啟Gzip壓縮，開啟將對特定文件類型進行壓縮；關閉則不會對任何文件類型進行壓縮
取值：on / off
默認值：on

返回參數

全是公共返回參數，詳見 <公共請求參數>

示例

請求示例

  1. https://slb.aliyuncs.com/
  2. &Action=CreateLoadBalancerHTTPSListener
  3. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  4. &ListenerPort=80
  5. &BackendServerPort=80
  6. &Bandwidth=-1
  7. &HealthCheck=on
  8. &HealthCheckDomain=$_ip
  9. &HealthCheckURI=/test/index.html
  10. &HealthCheckConnectPort=8080
  11. &HealthyThreshold=4
  12. &UnhealthyThreshold=4
  13. &HealthCheckTimeout=3
  14. &HealthCheckInterval=5
  15. &HealthCheckHttpCode=http_2xx,http_3xx
  16. &ServerCertificateId=idkp-123-cn-test-01
  17. &VServerGroupId=rsp-cige6j5e7p
  18. &<公共請求參數>

返回示例

  • XML 格式
    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <CreateLoadBalancerHTTPSListenerResponse>
    3.       <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    4.   </CreateLoadBalancerHTTPSListenerResponse>
  • JSON格式
    1. {"RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
    2.       }

最後更新：2016-11-23 16:03:57

  上一篇：go CreateLoadBalancerHTTPListener__Listener相關API_API 參考_負載均衡-阿裏雲
  下一篇：go CreateLoadBalancerTCPListener__Listener相關API_API 參考_負載均衡-阿裏雲