全部產品
Search

搜尋本產品

    Server Load Balancer：SetRule - 修改目標虛擬伺服器組的轉寄規則

    文件中心

    Server Load Balancer：SetRule - 修改目標虛擬伺服器組的轉寄規則

    更新時間：Dec 14, 2025

    修改目標虛擬伺服器組的轉寄規則。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    slb:SetRule

    update

    *loadbalancer

    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
    • slb:tag
    • slb:tag
    • slb:tag
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    Server Load Balancer執行個體的地區 ID。

    您可以通過調用 DescribeRegions 介面查詢地區 ID。

    cn-hangzhou
    RuleId

    string

    是

    轉寄規則 ID。

    rule-3ejhkt****
    VServerGroupId

    string

    否

    轉寄規則的目標伺服器組 ID。

    rsp-cige6****
    RuleName

    string

    否

    轉寄規則名稱，長度限制為 1~40 個字元，支援中文、字母、數字、短劃線（-）、正斜線（/）、半形句號（.）和底線（_）這些字元。

    說明

    同一個監聽內不同規則的名稱必須唯一。

    doctest
    ListenerSync

    string

    否

    是否繼承監聽的健全狀態檢查、會話保持和調度演算法配置。取值：

    • on：繼承監聽配置。

    • off：不繼承監聽配置。轉寄規則自訂健全狀態檢查及會話保持配置。

    off
    Scheduler

    string

    否

    調度演算法。取值：

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

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

    說明

    在 ListenerSync 為 off 時必選且有效。

    wrr
    StickySession

    string

    否

    是否開啟會話保持，取值：

    • on：開啟。

    • off：不開啟。

    在 ListenerSync 為 off 時必選且有效。

    off
    StickySessionType

    string

    否

    Cookie 的處理方式。取值：

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

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

    說明

    StickySession 為 on 時必選且有效。

    insert
    CookieTimeout

    integer

    否

    Cookie 逾時時間。單位：秒。取值範圍：1~86400。

    說明

    當 StickySession 為 on 且 StickySessionType 為 insert 時必選且有效。

    123
    Cookie

    string

    否

    伺服器上配置的 Cookie。

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

    說明

    當 StickySession 為 on 且 StickySessionType 為 server 時必選且有效。

    23ffsa
    HealthCheck

    string

    否

    是否開啟健全狀態檢查。取值：

    • on：開啟。

    • off：不開啟。

    說明

    ListenerSync 為 off 時必選且有效，其他情況會忽略此參數。

    off
    HealthCheckDomain

    string

    否

    用於健全狀態檢查的網域名稱，取值：

    • $_ip： 後端伺服器的私網 IP。當指定了$_ip 或 HealthCheckDomain 未指定時，負載平衡會使用各後端伺服器的私網 IP 當做健全狀態檢查使用的網域名稱。

    • domain：網域名稱長度為 1~80 字元，只能包含字母、數字、半形句號（.）和短劃線（-）。

    說明

    ** HealthCheck**為 on 時有效。

    $_ip
    HealthCheckURI

    string

    否

    用於健全狀態檢查的 URI。

    說明

    HealthCheck 為 on 時必選且有效。

    /example
    HealthyThreshold

    integer

    否

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

    取值範圍：2~10。

    說明

    HealthCheck 為 on 時必選且有效。

    4
    UnhealthyThreshold

    integer

    否

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

    取值範圍：2~10。

    說明

    HealthCheck 為 on 時必選且有效。

    4
    HealthCheckTimeout

    integer

    否

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

    說明

    HealthCheck 為 on 時必選且有效。

    20
    HealthCheckInterval

    integer

    否

    健全狀態檢查的時間間隔。單位：秒。取值範圍：1~50。

    說明

    HealthCheck 為 on 時必選且有效。

    20
    HealthCheckConnectPort

    integer

    否

    健全狀態檢查使用的連接埠。取值範圍：1~65535。

    說明

    HealthCheck 為 on 時有效。

    80
    HealthCheckHttpCode

    string

    否

    健全狀態檢查正常的 HTTP 狀態代碼，多個狀態代碼用半形逗號（,）分割。

    取值：http_2xx或http_3xx 或http_4xx或http_5xx。

    說明

    HealthCheck 為 on 時必選且有效。

    http_2xx

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParameter The specified VServerGroupId does not belong to the LoadBalancerId of the rule.
    400 InvalidParameter.RegionNotSupport The region does not support the parameter: %s.

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

    變更歷史

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