UpdateServerGroupAttribute - 補救伺服器組屬性 - Server Load Balancer

更新負載平衡伺服器組屬性。

介面說明

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

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

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gwlb:UpdateServerGroupAttribute

update

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ServerGroupId	string	是	伺服器組 ID。	sgp-atstuj3rtoptyui****
ServerGroupName	string	否	伺服器組名稱。長度為 2~128 個字元，必須以大小寫字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-）。	testServerGroupName
Scheduler	string	否	調度演算法。取值： 5TCH：五元組雜湊，基於五元組（源 IP、目的 IP、源連接埠、目的連接埠和協議）的一致性雜湊，相同的流會調度到相同的後端伺服器。 3TCH：三元組雜湊，基於三元組（源 IP、目的 IP 和協議）的一致性雜湊，相同的流會調度到相同的後端伺服器。 2TCH：二元組雜湊，基於二元組（源 IP 和目的 IP）的一致性雜湊，相同的流會調度到相同的後端伺服器。	5TCH
ServerFailoverMode	string	否	伺服器異常時，存量流量的處理方式。取值： NoRebalance：不重新平衡現有流量。 Rebalance：重新平衡現有流量。	NoRebalance
ConnectionDrainConfig	object	否	串連優雅中斷相關配置。
ConnectionDrainEnabled	boolean	否	是否開啟串連優雅中斷。取值： true：開啟。 false：關閉。	false
ConnectionDrainTimeout	integer	否	串連優雅中斷逾時時間。單位：秒。取值範圍：1~3600。	300
HealthCheckConfig	object	否	健全狀態檢查相關配置。
HealthCheckConnectPort	integer	否	健全狀態檢查使用的後端伺服器的連接埠。取值範圍： 1~65535。	80
HealthCheckConnectTimeout	integer	否	健全狀態檢查響應的最大逾時時間。單位：秒。取值範圍：1~300。	5
HealthCheckDomain	string	否	用於健全狀態檢查的網域名稱。取值： $SERVER_IP：使用後端伺服器內網 IP。 domain：指定特定網域名稱。長度限制 1~80 個字元，只能使用大小寫字母、數字、短劃線（-）、半形句號（.）。說明僅 HealthCheckProtocol 為 HTTP 時，該參數生效。	$SERVER_IP
HealthCheckEnabled	boolean	否	是否開啟健全狀態檢查，取值： true：開啟。 false：關閉。	true
HealthCheckHttpCode	array	否	健康狀態返回碼列表。
	string	否	健康狀態返回碼，多個狀態代碼用半形逗號（,）分隔。取值： http_2xx：返回 HttpCode 為 2xx 視為健康狀態。 http_3xx：返回 HttpCode 為 3xx 視為健康狀態。 http_4xx：返回 HttpCode 為 4xx 視為健康狀態。 http_5xx：返回 HttpCode 為 5xx 視為健康狀態。預設值：http_2xx 。說明僅 HealthCheckProtocol 為 HTTP 時，該參數生效。	http_2xx
HealthCheckInterval	integer	否	健全狀態檢查的時間間隔。單位：秒。取值範圍：1~50。	10
HealthCheckPath	string	否	健全狀態檢查路徑。長度為 1~80 個字元，只能使用大小寫英文字母、數字、字元`-/.%?#&`。必須以正斜線（/）開頭。說明僅 HealthCheckProtocol 為 HTTP 時，該參數生效。	/test/index.html
HealthCheckProtocol	string	否	健全狀態檢查協議，取值： TCP：通過發送 SYN 握手報文來檢測伺服器連接埠是否存活。 HTTP：通過發送 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。	TCP
HealthyThreshold	integer	否	健全狀態檢查連續成功多少次後，將後端伺服器的健全狀態檢查狀態由失敗判定為成功。取值範圍：2~10。	2
UnhealthyThreshold	integer	否	健全狀態檢查連續失敗多少次後，將後端伺服器的健全狀態檢查狀態由成功判定為失敗。取值範圍：2~10。	2
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。	54B48E3D-DF70-471B-AA93-08E683A1B45

樣本

正常返回樣本

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45\n"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParam.HealthCheckProtocol	The param of %s is illegal.	健全狀態檢查協議非法，請檢查輸入參數。
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	資源%s目前狀態%s不支援操作
400	OperationDenied.SchedulerNotConfigurable	The scheduling algorithm of server group is configurable only when TCP idle timeout of listener is default value.	TCP串連空閑逾時時間為非預設值時，伺服器組調度演算法僅支援五元組雜湊。
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	指定的伺服器組資源不存在。

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

變更歷史

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