全部產品
Search

搜尋本產品

    Server Load Balancer：UpdateListenerAttribute - 更新監聽配置

    文件中心

    Server Load Balancer：UpdateListenerAttribute - 更新監聽配置

    更新時間：Dec 21, 2025

    更新網路型負載平衡監聽的配置。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    nlb:UpdateListenerAttribute

    update

    *LoadBalancer

    acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
    • nlb:SecurityPolicyId
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ListenerId

    string

    是

    監聽執行個體 ID。

    lsn-bp1bpn0kn908w4nbw****@443
    ListenerDescription

    string

    否

    自訂監聽名稱。

    長度限制為 2~256 個字元，支援中文和英文字母，可包含數字、半形逗號（,）、半形句號（.）、半形分號（;）、正斜線（/）、at（@）、底線（_）和短劃線（-）。

    tcpssl_443
    ServerGroupId

    string

    否

    伺服器組 ID。

    說明

    • 當監聽為 TCP 時，該監聽支援選擇後端協議為 TCP 或者TCP_UDP的伺服器組，不支援選擇後端協議為 UDP 的伺服器組。

    • 當監聽為 UDP 時，該監聽支援選擇後端協議為 UDP 或者TCP_UDP的伺服器組，不支援選擇後端協議為 TCP 的伺服器組。

    • 當監聽為 TCPSSL 時，該監聽支援選擇後端協議為 TCP 且未開啟用戶端地址保持功能的伺服器組，不支援選擇後端協議為 TCP 且開啟用戶端地址保持功能的伺服器組、後端協議為 UDP 或者TCP_UDP的伺服器組。

    sgp-ppdpc14gdm3x4o****
    SecurityPolicyId

    string

    否

    安全性原則 ID。

    說明

    僅對 TCPSSL 監聽生效。

    tls_cipher_policy_1_1
    CertificateIds

    array

    否

    伺服器憑證列表資訊。目前僅支援添加 1 個伺服器憑證。

    說明

    僅對 TCPSSL 監聽生效。

    string

    否

    伺服器憑證列表資訊。目前僅支援添加 1 個伺服器憑證。

    說明

    僅對 TCPSSL 監聽生效。

    123157******
    CaCertificateIds

    array

    否

    CA 憑證列表資訊。目前僅支援添加 1 個 CA 憑證。

    說明

    僅對 TCPSSL 監聽生效。

    string

    否

    CA 憑證列表資訊。目前僅支援添加 1 個 CA 憑證。

    說明

    僅對 TCPSSL 監聽生效。

    139a00******
    CaEnabled

    boolean

    否

    是否啟動雙向認證。取值：

    • true：啟動。

    • false（預設值）：關閉。

    false
    IdleTimeout

    integer

    否

    串連空閑逾時時間。單位：秒。

    • 當監聽為 TCP 或 TCPSSL 時，串連空閑逾時時間取值範圍為：10~900。預設值：900。

    • 當監聽為 UDP 時，串連空閑逾時時間取值範圍為：10~20。預設值：20。

    900
    DryRun

    boolean

    否

    是否只預檢此次請求。取值：

    • true：發送檢查請求，不會更新監聽資訊。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼DryRunOperation。

    • false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行操作。

    false
    ClientToken

    string

    否

    用戶端 Token，用於保證請求的等冪性。

    從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

    說明

    若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。

    123e4567-e89b-12d3-a456-426655440000
    RegionId

    string

    否

    網路型Server Load Balancer執行個體所在的地區 ID。

    您可以通過調用 DescribeRegions 介面擷取地區 ID。

    cn-hangzhou
    ProxyProtocolEnabled

    boolean

    否

    是否開啟通過 Proxy Protocol 協議攜帶用戶端源地址到後端伺服器。取值：

    • true：開啟。

    • false：關閉。

    false
    SecSensorEnabled

    boolean

    否

    是否開啟秒級監控功能。取值：

    • true：開啟。

    • false：關閉。

    false
    AlpnEnabled

    boolean

    否

    是否開啟 ALPN。取值：

    • true：開啟。

    • false：關閉。

    false
    AlpnPolicy

    string

    否

    ALPN 策略。取值：

    • HTTP1Only：只協商使用 HTTP1.x 協議，優先順序為 HTTP1.1>HTTP1.0。

    • HTTP2Only：只協商使用 HTTP2.0 協議。

    • HTTP2Optional：優先使用 HTTP1.x 協議，但也接受 HTTP2.0 協議，優先順序為 HTTP1.1>HTTP1.0>HTTP2.0。

    • HTTP2Preferred：優先使用 HTTP2.0 協議，但也接受 HTTP1.x 協議，優先順序為 HTTP2.0>HTTP1.1>HTTP1.0。

    說明

    AlpnEnabled 開啟後需配置該參數。

    HTTP1Only
    Cps

    integer

    否

    該監聽在每個可用性區域（VIP）處理的每秒建立串連限速值。取值範圍：0~1000000。0 表示不限速。

    10000
    Mss

    integer

    否

    TCP 報文的最大段大小。單位：位元組，取值範圍：0~1500。0 表示不修改使用者 TCP 報文的 MSS 值。僅 TCP、TCPSSL 類型的監聽支援該欄位值。

    344
    ProxyProtocolV2Config

    object

    否

    通過 Proxy Protocol 協議攜帶 VpcId、PrivateLinkEpId、PrivateLinkEpsId 資訊到後端伺服器配置。

    Ppv2VpcIdEnabled

    boolean

    否

    是否開啟通過 Proxy Protocol 協議攜帶 VpcId 到後端伺服器。取值：

    • true：開啟。

    • false：關閉。

    false
    Ppv2PrivateLinkEpIdEnabled

    boolean

    否

    是否開啟通過 Proxy Protocol 協議攜帶 PrivateLinkEpId 到後端伺服器。取值：

    • true：開啟。

    • false：關閉。

    false
    Ppv2PrivateLinkEpsIdEnabled

    boolean

    否

    是否開啟通過 Proxy Protocol 協議攜帶 PrivateLinkEpsId 到後端伺服器。取值：

    • true：開啟。

    • false：關閉。

    false

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    更新監聽配置。

    RequestId

    string

    請求 ID。

    CEF72CEB-54B6-4AE8-B225-F876FF7BA984
    JobId

    string

    非同步任務 ID。

    72dcd26b-f12d-4c27-b3af-18f6aed5****

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Mismatch.VpcId The VpcId is mismatched for %s and %s. 資源%s和資源%s的VpcId不匹配。請檢查兩種資源是否在同一個VPC下。
    400 Conflict.Port The Port [%s] is conflict. 指定連接埠與已有連接埠存在衝突
    400 ResourceNotFound.Certificate The specified resource %s is not found. 資源%s不存在。
    400 IncorrectStatus.listener The status of listener [%s] is incorrect. 監聽的狀態無法進行當前操作，請檢查監聽當前是否處於其他動作下。
    400 IdempotenceSignatureMismatch The idempotence token of request is same with the prev one, but the signature is different. 請求的等冪令牌與上一個相同，但簽名不同。
    400 DryRunOperation Request validation has been passed with DryRun flag set. dryRun請求驗證已通過。
    400 ResourceAlreadyAssociated.Certificate The specified resource %s is already associated. 資源%s已被關聯。
    400 IllegalParamSize.certificateIds The param size of certificateIds or caCertificateIds is illegal. 認證的id只能有一個，請檢查是否重複輸入。
    400 SystemBusy System is busy, please try again later. 系統繁忙，請稍後重試
    400 IllegalParam.IdleTimeout The param of IdleTimeout is illegal. 參數串連空閑逾時時間配置非法。
    400 OperationDenied.RegionNotSupportHDMonitor The operation is not allowed because of RegionNotSupportHDMonitor. 目前範圍不支援秒級監控。
    400 ResourceNotEnough.CaCertificateApiCount The specified resource of CaCertificateApiCount is not enough.
    400 IllegalParam The param of %s is illegal. 輸入的參數有值非法，請檢查輸入。
    403 Forbidden.NoPermission Authentication is failed for NoPermission. 因為帳號沒有許可權，所以鑒權失敗。
    404 ResourceNotFound.listener The specified resource %s is not found. 資源%s不存在。
    404 ResourceNotFound.HdMonitorConfigNotExist The specified resource of HdMonitorConfigNotExist is not found. HdMonitorConfig 不存在，請檢查輸入參數。
    404 ResourceNotFound.CaCertificate The specified resource of CaCertificate is not found. Ca認證不存在，請檢查輸入參數。
    404 ResourceNotFound.securitypolicy The specified resource of securitypolicy is not found. 找不到指定的安全性原則資源。請檢查輸入參數。

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

    變更歷史

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