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

描述

創建TCP Listener，為負載均衡實例創建基於TCP協議的Listener，包含基於TCP協議的策略及健康檢查配置。
新創建的Listener為Stoped狀態，需調用StartLoadBalancerListener，使之生效。Listener的狀態轉換圖，參見負載均衡 Listener狀態轉換圖。
TCP Listener的健康檢查永遠為開啟狀態，用戶可設置健康檢查時的各項參數配置，但是不能將健康檢查關閉。TCP Listener的健康檢查默認為使用TCP方式進行健康檢查，如需要使用HTTP方式進行健康檢查，需要設置特定的參數。

請求參數

名稱	類型	是否必須	描述
Action	String	是	操作接口名，係統規定參數。取值：CreateLoadBalancerTCPListener
LoadBalancerId	String	是	負載均衡實例的唯一標識。
ListenerPort	Integer	是	負載均衡實例前端使用的端口。取值：1-65535
BackendServerPort	Integer	是	負載均衡實例後端使用的端口。取值：1-65535
Bandwidth	Integer	是	監聽的帶寬峰值。取值：-1 / 1-1000Mbps 針對按固定帶寬計費方式的公網類型實例，不同Listener上的Bandwidth分配的帶寬峰值總和不能超出在創建負載均衡實例時設定的Bandwidth值，且不能將Listener上的Bandwidth設置為-1；針對按使用流量計費方式的公網類型實例，可以選擇將Listener上的Bandwidth設置為-1，表示不限製帶寬峰值。
Scheduler	String	否	調度算法。取值：wrr/wlc 默認值：wrr
PersistenceTimeout	Integer	否	連接持久化的超時時間。取值： 0-1000（單位為秒）默認值：0 其中，0表示關閉。
HealthCheckType	String	否	健康檢查類型。取值：tcp/http 默認值：tcp TCP協議支持使用TCP和HTTP兩種健康檢查方式，可根據應用情況選擇需要的健康檢查方式。
HealthCheckDomain	String	否	用於健康檢查的域名。當TCP監聽需要使用HTTP健康檢查時可配置此參數，如不配置則按TCP健康檢查。取值： $_ip/用戶自定義字符串/空自定義字符串規則：長度限製為1-80，隻能使用字母、數字、‘-’、‘.’這些字符。用戶設置此參數為’$_ip’或空時，負載均衡會使用各後端服務器的私網IP當做健康檢查使用的Domain。注：由於有的Region還存在BUG，暫時無法支持健康檢查域名設置，我們正在加緊修複該問題。當前請使用TCP健康檢查或者不設置HTTP健康檢查域名，係統會統一使用各後端服務器的內網IP作為域名。
HealthCheckURI	String	視情況而定	用於健康檢查的URI。當TCP監聽需要使用HTTP健康檢查時可配置此參數，如不配置則按TCP健康檢查。取值：長度限製為1-80，必須以’/’開頭。隻能使用字母、數字、‘-’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’這些字符。
HealthCheckConnectPort	Integer	否	進行健康檢查使用的端口。取值： 1-65535 默認值：無不設置此參數時，表示使用後端服務端口（BackendServerPort）。
HealthyThreshold	Integer	否	判定健康檢查結果為success的閾值。即，健康檢查連續成功多少次後，將後端服務器的健康檢查結果由fail改為success。取值：1-10 默認值：3
UnhealthyThreshold	Integer	視情況而定	判定健康檢查結果為fail的閾值。即，健康檢查連續失敗多少次後，將後端服務器的健康檢查狀態由success改為fail。取值：1-10 默認值：3
HealthCheckConnectTimeout	Integer	否	健康檢查的連接超時時間。取值：1-50（單位為秒）默認值：5
HealthCheckInterval	Integer	否	進行健康檢查的時間間隔。取值：1-5（單位為秒）默認值：2
HealthCheckHttpCode	String	否	健康檢查正常的http狀態碼，多個http狀態碼間用”,”分割。當TCP監聽需要使用HTTP健康檢查時可配置此參數。如不配置則按TCP健康檢查取值：http_2xx \| http_3xx/http_4xx/http_5xx 默認值：http_2xx
VServerGroupId	String	否	虛擬服務器組ID

返回參數

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

示例

請求示例

    https://slb.aliyuncs.com/
    &Action=CreateLoadBalancerTCPListener
    &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
    &ListenerPort=443
    &BackendServerPort=443
    &Bandwidth=-1
    &VServerGroupId=rsp-cige6j5e7p
    &<公共請求參數>

返回示例

XML格式

      <?xml version="1.0" encoding="UTF-8"?>
      <CreateLoadBalancerTCPListenerResponse>
          <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
      </CreateLoadBalancerTCPListenerResponse>

JSON格式

      {"RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
      }

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

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

描述

請求參數

返回參數

示例

請求示例

返回示例

上一篇： CreateLoadBalancerHTTPSListener__Listener相關API_API 參考_負載均衡-阿裏雲

下一篇： CreateLoadBalancerUDPListener__Listener相關API_API 參考_負載均衡-阿裏雲

相關內容

熱門內容

最新內容