全部產品
Search

搜尋本產品

    Server Load Balancer：UpdateServerGroupAttribute - 補救伺服器組配置

    文件中心

    Server Load Balancer：UpdateServerGroupAttribute - 補救伺服器組配置

    更新時間：Dec 19, 2025

    補救伺服器組的配置，例如健全狀態檢查、會話保持、名稱、調度演算法和協議等。

    介面說明

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

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

    • 當伺服器組的配置處於 Available 狀態時，表示伺服器組的配置更新成功。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    alb:UpdateServerGroupAttribute

    update

    *ServerGroup

    acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ServerGroupName

    string

    否

    伺服器組名稱。

    長度為 2~128 個英文或中文字元，必須以大小字母或中文開頭，可包含數字，半形句號（.），底線（_）和短劃線（-）。

    test
    Scheduler

    string

    否

    調度演算法。取值：

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

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

    • Sch：一致性雜湊，相同雜湊因子計算結果的請求將會調度到相同的後端伺服器。不配置 UchConfig 參數時，預設雜湊因子為源 IP，相同源 IP 位址的請求會分發到同一台後端伺服器；配置了 UchConfig 參數時，雜湊因子為 URL 參數，相同 URL 參數的請求會分發到同一台後端伺服器。

    Wrr
    ClientToken

    string

    否

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

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

    說明

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

    5A2CFF0E-5718-45B5-9D4D-70B3******
    DryRun

    boolean

    否

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

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

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

    true
    HealthCheckConfig

    object

    否

    健全狀態檢查相關配置結構體。

    HealthCheckConnectPort

    integer

    否

    健全狀態檢查的後端伺服器的連接埠。

    取值範圍：0~65535。

    設定為 0 時代表使用後端伺服器的連接埠進行健全狀態檢查。

    說明

    當前伺服器組 HealthCheckEnabled 為 true 時，該參數配置生效。

    80
    HealthCheckEnabled

    boolean

    否

    是否啟用健全狀態檢查，取值：

    • true：啟用

    • false：不啟用

    true
    HealthCheckHost

    string

    否

    健全狀態檢查網域名稱。

    • 使用後端伺服器的內網 IP（預設）：使用後端伺服器的內網 IP 位址作為健全狀態檢查的網域名稱。

    • 指定特定網域名稱：輸入一個網域名稱。

      • 長度限制為 1~80 個字元。

      • 可包含小寫字母、數字、短劃線（-）和半形句號（.）。

      • 至少包含一個半形句號（.），半形句號（.）不能出現在開頭或結尾。

      • 最右側的域標籤，只能包含字母，不能包含數字或短劃線（-）。

      • 短劃線（-）不能出現在開頭或結尾。

    說明

    只有 HealthCheckProtocol 設定為 HTTP、HTTPS 或 gRPC 時，該參數生效。

    example.com
    HealthCheckCodes

    array

    否

    健全狀態檢查正常的狀態代碼列表。

    string

    否

    健全狀態檢查正常的狀態代碼。

    • 當 HealthCheckProtocol 取值為 HTTP 或 HTTPS 時，HealthCheckCodes 可以選擇http_2xx（預設值）、 http_3xx、http_4xx和http_5xx。多個狀態代碼用半形逗號（,）分隔。

    • 當 HealthCheckProtocol 取值為 gRPC 時，HealthCheckCodes 狀態代碼範圍：0~99，預設值：0。支援範圍輸入，最多支援 20 個範圍值。多個範圍值使用半形逗號（,）隔開。

    說明

    當前伺服器組 HealthCheckEnabled 為 true 且 HealthCheckProtocol 設定為 HTTP 或 HTTPS 或 gRPC 時該參數生效。

    200
    HealthCheckHttpVersion

    string

    否

    健全狀態檢查 HTTP 協議版本。取值：

    • HTTP1.0

    • HTTP1.1

    說明

    當前伺服器組 HealthCheckEnabled 為 true 且 HealthCheckProtocol 設定為 HTTP 或 HTTPS 時該參數生效。

    HTTP1.1
    HealthCheckInterval

    integer

    否

    健全狀態檢查的時間間隔。單位：秒。

    取值範圍：1~50。

    說明

    當前伺服器組 HealthCheckEnabled 為 true 時，該參數配置生效。

    5
    HealthCheckMethod

    string

    否

    健全狀態檢查方法。取值：

    • GET：如果響應報文長度超過 8K，會被截斷，但不會影響健全狀態檢查結果的判定。

    • POST：gRPC 監聽健全狀態檢查預設採用 POST 方法。

    • HEAD：HTTP 和 HTTPS 監聽健全狀態檢查預設採用 HEAD 方法。

    說明

    當前伺服器組 HealthCheckEnabled 為 true 且 HealthCheckProtocol 設定為 HTTP 或 HTTPS 或 gRPC 時該參數生效。

    HEAD
    HealthCheckPath

    string

    否

    健全狀態檢查的轉寄規則路徑。

    長度限制為 1~80，只能使用字母、數字、字元-/.%?#&=以及擴充字元_;~!（)*[]@$^:',+。 URL 開頭必須為/。

    說明

    當前伺服器組 HealthCheckEnabled 為 true 且 HealthCheckProtocol 設定為 HTTP 或 HTTPS 時該參數生效。

    /test/index.html
    HealthCheckProtocol

    string

    否

    健全狀態檢查協議。取值：

    • HTTP：通過發送 HEAD 或 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。

    • HTTPS：通過發送 HEAD 或 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。（資料加密，相比 HTTP 更安全。）

    • TCP：通過發送 SYN 握手報文來檢測伺服器連接埠是否存活。

    • gRPC：通過發送 POST 或 GET 請求來檢查伺服器應用是否健康。

    HTTP
    HealthCheckTimeout

    integer

    否

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

    取值範圍：1~300。

    說明

    當前伺服器組 HealthCheckEnabled 為 true 時，該參數配置生效。

    3
    HealthyThreshold

    integer

    否

    健全狀態檢查連續成功多少次後，將後端伺服器的健全狀態檢查狀態由 fail 判定為 success。

    取值範圍：2~10。

    4
    UnhealthyThreshold

    integer

    否

    健全狀態檢查連續失敗多少次後，將後端伺服器的健全狀態檢查狀態由 success 判定為 fail。

    取值範圍：2~10。

    4
    StickySessionConfig

    object

    否

    會話保持配置結構體

    Cookie

    string

    否

    伺服器上配置的 Cookie。

    長度為 1~200 個字元，只能包含 ASCII 英文字母和數字字元，不能包含半形逗號（,）、半形分號（;）或空格，也不能以貨幣符號（$）開頭。

    說明

    當前伺服器組 StickySessionEnabled 為 true 且 StickySessionType 配置為 Server 時，該參數生效。

    B490B5EBF6F3CD402E515D22B******
    CookieTimeout

    integer

    否

    Cookie 逾時時間。單位：秒。

    取值範圍：1~86400。

    說明

    當前伺服器組 StickySessionEnabled 為 true 且 StickySessionType 配置為 Insert 時，該參數生效。

    1000
    StickySessionEnabled

    boolean

    否

    是否啟用會話保持。取值：

    • true：是。

    • false：否。

    false
    StickySessionType

    string

    否

    Cookie 的處理方式。取值：

    • Insert：植入 Cookie。 用戶端第一次訪問時，負載平衡會在返回請求中植入 Cookie（即在 HTTP 或 HTTPS 響應報文中插入 SERVERID），下次用戶端攜帶此 Cookie 訪問，負載平衡服務會將請求定向轉寄給之前記錄到的後端伺服器上。

    • Server：重寫 Cookie。 負載平衡發現使用者自訂了 Cookie，將會對原來的 Cookie 進行重寫，下次用戶端攜帶新的 Cookie 訪問，負載平衡服務會將請求定向轉寄給之前記錄到的後端伺服器。

    說明

    當前伺服器組 StickySessionEnabled 為 true 時，該參數生效。

    Insert
    ServerGroupId

    string

    是

    伺服器組 ID。

    sgp-atstuj3rtop****
    UpstreamKeepaliveEnabled

    boolean

    否

    是否開啟後端長串連。

    • true：開啟

    • false：不開啟。

    ServiceName

    string

    否

    僅適用於 ALB Ingress 情境，表示伺服器組對應的K8s Service名稱。

    test2
    UchConfig

    object

    否

    url 一致性 hash 參數配置。

    Type

    string

    是

    參數類型。只支援輸入 QueryString。

    QueryString
    Value

    string

    是

    一致性 hash 參數值。

    abc
    ConnectionDrainConfig

    object

    否

    串連優雅中斷相關配置。

    開啟串連優雅中斷，在移除後端伺服器或者健全狀態檢查失敗後，負載平衡使現有串連在一定時間內正常傳輸。

    說明

    • 基礎版執行個體不支援開啟串連優雅中斷，僅標準版、WAF 增強版執行個體支援。

    • 伺服器類型、IP 類型伺服器組支援串連優雅中斷，Function Compute類型不支援。

    ConnectionDrainEnabled

    boolean

    否

    是否開啟串連優雅中斷。

    • true：開啟

    • false：關閉

    false
    ConnectionDrainTimeout

    integer

    否

    串連優雅中斷逾時時間。

    取值範圍：0~900。

    300
    SlowStartConfig

    object

    否

    慢啟動相關配置。

    開啟慢啟動後，將會在設定的時間段內對新添加到後端伺服器組的後端伺服器進行預熱，轉寄到該伺服器的請求數量線性增加。

    說明

    • 基礎版執行個體不支援開啟慢啟動，僅標準版、WAF 增強版執行個體支援。

    • 伺服器類型、IP 類型伺服器組支援配置慢啟動，Function Compute類型不支援。

    • 慢啟動僅在後端調度演算法是加權輪詢演算法時可開啟。

    SlowStartEnabled

    boolean

    否

    是否開啟慢啟動。

    • true：開啟

    • false：關閉

    false
    SlowStartDuration

    integer

    否

    慢啟動期間。

    取值範圍：30~900。

    30
    CrossZoneEnabled

    boolean

    否

    伺服器組是否開啟跨 AZ 負載平衡。取值：

    • true：開啟（預設值）

    • false：關閉

    說明

    • 基礎版執行個體不支援綁定關閉跨 AZ 負載平衡的伺服器組，僅標準版、WAF 增強版執行個體支援。

    • 伺服器類型、IP 類型伺服器組支援關閉跨 AZ 負載平衡，Function Compute類型不支援。

    • 關閉跨 AZ 負載平衡時，不支援開啟會話保持。

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料結構組

    JobId

    string

    非同步任務 ID。

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

    string

    請求 ID。

    365F4154-92F6-4AE4-92F8-7FF3*****

    樣本

    正常返回樣本

    JSON格式

    {
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3*****"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 IncorrectStatus.ServerGroup The status of %s [%s] is incorrect. 伺服器組狀態無效。
    400 Mismatch.LoadBalancerEditionAndConnectionDrain The %s and %s are mismatched. 參數%s和%s不匹配。
    400 Mismatch.ServerGroupSchedulerAndSlowStartEnable The %s and %s are mismatched. 參數%s和%s不匹配。
    400 QuotaExceeded.ConnectionDrainTimeout The quota of %s is exceeded, usage %s/%s. 參數%s超過配額限制，當前值%s，配額值%s。
    400 UnsupportedFeature.ConnectionDrain The feature of %s is not supported. 不支援%s特性。
    400 QuotaExceeded.SlowStartDuration The quota of %s is exceeded, usage %s/%s. 參數%s超過配額限制，當前值%s，配額值%s。
    400 UnsupportedFeature.SlowStart The feature of %s is not supported. 不支援%s特性。
    400 Mismatch.LoadBalancerEditionAndSlowStartEnable The %s and %s are mismatched. 參數%s和%s不匹配。
    400 OperationDenied.UpstreamKeepaliveDisabled The operation is not allowed because of UpstreamKeepaliveDisabled. 不允許更新是否開啟後端長串連為關閉狀態
    400 OperationDenied.UpstreamKeepaliveEnabled The operation is not allowed because of UpstreamKeepaliveEnabled. 不允許更新是否開啟後端長串連為開啟狀態
    400 CloseUpstreamKeepaliveNotSupport The param of UpstreamKeepalive is not Support. 不支援關閉伺服器組的後端長連結
    404 ResourceNotFound.ServerGroup The specified resource %s is not found. 後端伺服器組不存在。

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

    變更歷史

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