全部產品
Search

搜尋本產品

    Server Load Balancer：UpdateListenerAttribute - 更新監聽屬性

    文件中心

    Server Load Balancer：UpdateListenerAttribute - 更新監聽屬性

    更新時間：Aug 06, 2025

    更新負載平衡監聽的屬性。

    介面說明

    UpdateListenerAttribute 介面屬於非同步介面，即系統返回一個請求 ID，但該監聽的配置尚未更新成功，系統背景更新任務仍在進行。您可以調用 GetListenerAttribute 查詢監聽的配置的更新狀態：

    • 當監聽器處於 Configuring 狀態時，表示監聽的配置正在更新中。

    • 當監聽器處於 Running 狀態時，表示監聽的配置更新成功。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    gwlb:UpdateListenerAttribute

    update

    *LoadBalancer

    acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

    *Listener

    acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}

    ServerGroup

    acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ListenerId

    string

    是

    監聽 ID。

    lsn-lxce8iqbof2vl0****
    ListenerDescription

    string

    否

    自訂監聽描述。

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

    listener_description
    ServerGroupId

    string

    否

    伺服器組 ID。

    sgp-sp8d2r6y7t0xtl****
    TcpIdleTimeout

    integer

    否

    TCP 串連空閑逾時時間。取值範圍：60-6000 秒。

    350
    DryRun

    boolean

    否

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

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

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

    false
    ClientToken

    string

    否

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

    說明

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

    123e4567-e89b-12d3-a456-42665544****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    請求的傳回值。

    RequestId

    string

    請求 ID。

    7DBFC67C-A272-5952-8287-6C3EBE4E04D9

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 IncorrectBusinessStatus.LoadBalancer The business status of %s [%s] is incorrect. 資源%s業務狀態%s不支援當前操作
    400 IncorrectStatus.LoadBalancer The status of %s [%s] is incorrect. 資源%s目前狀態%s不支援操作
    400 IncorrectStatus.Listener The status of %s [%s] is incorrect. 資源%s目前狀態%s不支援操作。
    400 Mismatch.VpcId The %s is mismatched for %s and %s. 兩個資源的VPC ID不匹配
    400 ResourceInUse.IP The specified resource of IP is in use.
    400 IncorrectStatus.ServerGroup The status of %s [%s] is incorrect. 資源%s目前狀態%s不支援操作
    400 OperationDenied.TcpIdleTimeoutConflictWithScheduler The TCP idle timeout of listener must be default value when the scheduling algorithm of server group is not 5TCH. 配置衝突，自訂配置了的TCP串連空閑逾時時間，伺服器組的調度演算法需要使用五元組雜湊。
    400 OperationDenied.TcpIdleTimeoutNotConfigurable The TCP idle timeout of listener is configurable only when the scheduling algorithm of server group is 5TCH. 當伺服器組調度演算法為五元組雜湊時，可以自訂配置TCP串連空閑逾時時間。其他調度演算法，無法修改。
    404 ResourceNotFound.LoadBalancer The specified resource of %s is not found. 指定的負載平衡資源不存在
    404 ResourceNotFound.Listener The specified resource of %s is not found. 指定的監聽資源不存在
    404 ResourceNotFound.ServerGroup The specified resource of %s is not found. 指定的伺服器組資源不存在。

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

    變更歷史

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