全部產品
Search

搜尋本產品

    ENS：CreateLoadBalancerTCPListener - 建立TCP監聽

    文件中心

    ENS：CreateLoadBalancerTCPListener - 建立TCP監聽

    更新時間：May 07, 2026

    調用CreateLoadBalancerTCPListener建立TCP監聽。

    介面說明

    • API 呼叫頻率：100 次/秒。

    • 單使用者調用頻率：10 次/秒。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ens:CreateLoadBalancerTCPListener

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    LoadBalancerId

    string

    是

    Server Load Balancer執行個體的 ID。

    lb-5ovkn1piwqmoqrfjdyhq4****
    ListenerPort

    integer

    是

    負載平衡對外提供服務，接收請求並向後端伺服器進行請求轉寄的監聽連接埠。取值：1~65535。

    80
    Description

    string

    否

    設定監聽名稱。長度限制為 1~80 個字元。

    說明

    不能以http://和https://開頭。

    example
    Scheduler

    string

    否

    調度演算法。取值：

    • wrr（預設值）：權重值越高的後端伺服器，被輪詢到的次數（機率）也越高。

    • wlc：除了根據每台後端伺服器設定的權重值來進行輪詢，同時還考慮後端伺服器的實際負載（即串連數）。當權重值相同時，當前串連數越小的後端伺服器被輪詢到的次數（機率）也越高。

    • rr：按照訪問順序依次將外部請求依序分發到後端伺服器。

    • sch：基於源 IP 位址的一致性 hash，相同的源地址會調度到相同的後端伺服器。

    • tch：基於四元組的一致性 hash（源 IP+目的 IP+源連接埠+目的連接埠），相同的流會調度到相同的後端伺服器。

    wrr
    PersistenceTimeout

    integer

    否

    會話保持的逾時時間。

    • 預設值：0，表示關閉會話保持。

    • 取值：0~3600。

    • 單位：秒。

    0
    EstablishedTimeout

    integer

    否

    連線逾時時間，取值：10~900，預設值為 900，單位：秒。

    500
    HealthyThreshold

    integer

    否

    健全狀態檢查連續成功多少次後，將後端伺服器的健全狀態檢查狀態由 fail（後台伺服器不可達）判定為 success（後台伺服器可達）。取值：2~10，預設值為 3。

    4
    UnhealthyThreshold

    integer

    否

    健全狀態檢查連續失敗多少次後，將後端伺服器的健全狀態檢查狀態由 success（後台伺服器可達）判定為 fail（後台伺服器不可達）。取值：2~10，預設值為 3。

    4
    HealthCheckConnectTimeout

    integer

    否

    接收來自健全狀態檢查的響應需要等待的時間。如果後端 ENS 在指定的時間內沒有響應，則判定為健全狀態檢查失敗。

    • 預設值：5 秒。

    • 取值：1~300。

    • 單位：秒。

    說明

    如果 HealthCheckConnectTimeout 的值小於 HealthCheckInterval 的值，則 HealthCheckConnectTimeout 無效，逾時時間為 HealthCheckInterval 的值。

    100
    HealthCheckInterval

    integer

    否

    健全狀態檢查的時間間隔。取值：1~50，預設值為 2，單位：秒。

    3
    HealthCheckDomain

    string

    否

    用於健全狀態檢查的網域名稱。

    www.aliyundoc.com
    HealthCheckURI

    string

    否

    用於健全狀態檢查的 URI。長度限制為 1~80。

    說明

    URL 不能只有/，但必須以/開頭。

    /checkpreload.htm
    HealthCheckHttpCode

    string

    否

    健全狀態檢查正常時的 HTTP 狀態代碼。取值：

    • http_2xx（預設值）。

    • http_3xx。

    • http_4xx。

    • http_5xx。

    http_2xx
    HealthCheckType

    string

    否

    健全狀態檢查類型。取值：

    • tcp（預設值）。

    • http。

    tcp
    BackendServerPort

    integer

    否

    Server Load Balancer執行個體後端伺服器使用的連接埠，取值：1~65535。

    8080
    HealthCheckConnectPort

    integer

    否

    健全狀態檢查使用的連接埠，取值：1~65535。不設定此參數時，表示使用後端服務連接埠（BackendServerPort）。

    8080
    EipTransmit

    string

    否

    是否開啟 EIP 透傳，取值：

    • on：開啟。

    • off（預設值）：關閉。

    on

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

    06F00FBB-3D9E-4CCE-9D43-1A6946A75456

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Invalid%s The specified parameter %s is invalid.
    400 Missing%s You must specify the parameter %s.
    400 LoadBalancerNotFound The input parameter loadBalancerId that is not found.
    400 IncorrectInstanceStatus The current status of the resource does not support this operation. 當前操作不被支援，磁碟正在重設中。
    400 ListenerAlreadyExists The listener already exists. 該監聽已存在。
    400 ens.interface.error Failed to call API. 介面調用發生異常。
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。