使用CreateServerGroup建立網路型負載平衡伺服器組-負載平衡-阿里雲 - Server Load Balancer

在指定地域建立伺服器群組。

介面說明

CreateServerGroup 介面屬於非同步介面，即系統回傳一個請求 ID，但該網路型負載平衡的伺服器群組尚未建立成功，系統後台的建立任務仍在進行。您可以呼叫 GetJobStatus 查詢伺服器群組的建立狀態：

當任務狀態處於 Succeeded 時，表示伺服器群組建立成功。
當任務狀態處於 Processing 時，表示伺服器群組正在建立中，在該狀態下，您只能執行查詢操作，不能執行其他操作。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

nlb:CreateServerGroup

create

*ServerGroup

acs:nlb:{#regionId}:{#accountId}:servergroup/*

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

無

請求參數

名稱	類型	必填	描述	樣本值
ServerGroupType	string	否	伺服器群組類型。取值： Instance（預設值）：伺服器類型，該類型伺服器群組支援新增 Ecs、Eni、Eci 類型執行個體。 Ip：IP 位址類型，該類型伺服器群組支援直接新增 IP 位址類型的後端伺服器。	Instance
ServerGroupName	string	是	伺服器群組名稱。長度為 2~128 個字元，必須以大小寫字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短橫線（-）。	NLB_ServerGroup
AddressIPVersion	string	否	通訊協定版本。取值： ipv4（預設值）：IPv4 類型。 DualStack：雙協定棧類型。	ipv4
IpVersionAffinityMode	string	否	雙協定堆疊模式下的流量排程策略： NonAffinity（預設）：無親和模式，轉送時不區分來源的 IP 通訊協定版本，按照排程演算法向健康的後端轉送。 Affinity：親和模式，轉送時根據請求來源的 IP 通訊協定版本親和轉送，IPv4 請求僅轉送至 IPv4 後端，IPv6 請求僅轉送至 IPv6 後端。說明僅 AddressIPVersion 為 DualStack 時，該參數生效。	Affinity
Protocol	string	否	轉送到後端伺服器使用的通訊協定。取值： TCP（預設值） UDP TCP_UDP 說明當該參數取值為 UDP 時，該伺服器群組僅支援關聯 UDP 監聽。當該參數取值為 TCP 且 PreserveClientIpEnabled 取值為 true 時，該伺服器群組僅支援關聯 TCP 監聽。當該參數取值為 TCP 且 PreserveClientIpEnabled 取值為 false 時，該伺服器群組支援關聯 TCPSSL 監聽和 TCP 監聽。當該參數取值為TCP_UDP時，該伺服器群組支援關聯 TCP 監聽和 UDP 監聽。	TCP
VpcId	string	是	伺服器群組所在 VPC 的 ID。說明如果 ServerGroupType 取值為 Instance 時，只有該 VPC 下的伺服器可以加入到該伺服器群組。	vpc-bp15zckdt37pq72zv****
AnyPortEnabled	boolean	否	是否開啟全連接埠轉送。取值： true：開啟。 false（預設值）：關閉。	false
ConnectionDrainEnabled	boolean	否	是否開啟連線優雅中斷。取值： true：開啟。 false（預設值）：關閉。	false
ConnectionDrainTimeout	integer	否	設定連線優雅中斷逾時時間。單位：秒。取值範圍：0~900。	10
Scheduler	string	否	排程演算法。取值： Wrr（預設值）：加權輪詢，權重值越高的後端伺服器，被輪詢到的機率也越高。 Wlc：加權最小連線數，除了根據每台後端伺服器設定的權重值來進行輪詢，同時還考慮後端伺服器的實際負載（即連線數）。當權重值相同時，目前連線數越小的後端伺服器被輪詢到的機率也越高。 rr：輪詢，按照存取順序依次將外部請求分發到後端伺服器。 sch：來源 IP 雜湊：相同的來源位址會排程到相同的後端伺服器。 tch：四元組雜湊，基於四元組（來源 IP、目的 IP、來源連接埠和目的連接埠）的一致性雜湊，相同的資料流會排程到相同的後端伺服器。 qch：QUIC ID 雜湊，支援將同一個 QUIC ID 的請求雜湊到同一台後端伺服器上。說明僅後端通訊協定為 UDP 時，支援選擇 QUIC ID 雜湊。	Wrr
PreserveClientIpEnabled	boolean	否	是否開啟用戶端位址保留功能。取值： true（預設值）：開啟。 false：關閉。說明當 Protocol 取值為 TCP 且該參數取值為 true 時，該伺服器群組不支援關聯 TCPSSL 監聽。	true
HealthCheckConfig	object	否	健康檢查相關設定。
HealthCheckConnectPort	integer	否	健康檢查的後端伺服器的連接埠。取值範圍： 0~65535。預設值：0，表示使用後端伺服器的連接埠進行健康檢查。	0
HealthCheckConnectTimeout	integer	否	健康檢查回應的最大逾時時間。單位：秒。取值範圍：1~300。預設值：5。	5
HealthCheckDomain	string	否	用於健康檢查的網域。取值： $SERVER_IP：使用後端伺服器內部網路 IP。 domain：指定特定網域。長度限制 1~80 個字元，只能使用大小寫字母、數字、短橫線（-）、半形句號（.）。說明僅 HealthCheckType 為 HTTP 時，該參數生效。	$SERVER_IP
HealthCheckEnabled	boolean	否	是否開啟健康檢查，取值： true（預設值）：開啟。 false：關閉。	true
HealthCheckExp	string	否	UDP 監聽健康檢查的請求字串，僅允許包含字母、數字，最大長度限制為 512 個字元。	ok
HealthCheckHttpCode	array	否	健康狀態回應碼，多個狀態碼以半形逗號（,）分隔。取值：http_2xx（預設值）、http_3xx、http_4xx和http_5xx。說明僅 HealthCheckType 為 HTTP 時，該參數生效。
	string	否	健康狀態回應碼，多個狀態碼以半形逗號（,）分隔。取值：http_2xx（預設值）、http_3xx、http_4xx和http_5xx。說明僅 HealthCheckType 為 HTTP 時，該參數生效。	http_2xx
HealthCheckHttpVersion	string	否	健康檢查 HTTP 通訊協定版本，取值：HTTP1.0（預設值）或HTTP1.1。說明僅 HealthCheckType 為 HTTP 時，該參數生效。	HTTP1.0
HealthCheckInterval	integer	否	健康檢查的時間間隔。單位：秒。預設值：5 HealthCheckType 為 TCP 或 HTTP 時，取值範圍為：1~50。 HealthCheckType 為 UDP 時，取值範圍為：1~300，您需要設定間隔時間>=回應逾時時間，以確保 UDP 偵測回封包不會因為逾時而被誤判為未回應。	5
HealthCheckReq	string	否	UDP 監聽健康檢查的請求字串，僅允許包含字母、數字，最大長度限制為 512 個字元。	hello
HealthCheckType	string	否	健康檢查通訊協定。取值： TCP HTTP UDP	TCP
HealthCheckUrl	string	否	健康檢查路徑。長度為 1~80 個字元，只能使用大小寫英文字母、數字、字元`-/.%?#&`。必須以正斜線（/）開頭。說明僅 HealthCheckType 為 HTTP 時，該參數生效。	/test/index.html
HealthyThreshold	integer	否	健康檢查連續成功多少次後，將後端伺服器的健康檢查狀態由失敗判定為成功。取值範圍：2~10。預設值：2。	2
HttpCheckMethod	string	否	健康檢查方法，取值：GET（預設值）或 HEAD。說明僅 HealthCheckType 為 HTTP 時，該參數生效。	GET
UnhealthyThreshold	integer	否	健康檢查連續失敗多少次後，將後端伺服器的健康檢查狀態由成功判定為失敗。取值範圍：2~10。預設值：2。	2
ResourceGroupId	string	否	伺服器群組所屬的資源群組 ID。	rg-atstuj3rtop****
DryRun	boolean	否	是否僅預檢此次請求。取值： true：傳送檢查請求，不會建立伺服器群組。檢查項目包括是否填寫了必要參數、請求格式、業務限制。如果檢查未通過，則回傳對應錯誤。如果檢查通過，則回傳錯誤碼`DryRunOperation`。 false（預設值）：傳送正常請求，通過檢查後回傳 HTTP 2xx 狀態碼並直接進行操作。	true
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 僅支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 識別碼。每次 API 請求的 RequestId 不一樣。	123e4567-e89b-12d3-a456-426655440000
RegionId	string	否	網路型負載平衡執行個體所在的區域 ID。您可以透過呼叫 DescribeRegions 介面取得區域 ID。	cn-hangzhou
Tag	array<object>	否	標籤清單。
	object	否	標籤。
Key	string	否	標籤鍵。最多支援 64 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或`https://`。支援字元包括字母、數字、底線 (_)、點 (.)、冒號 (:)、斜線 (/)、等號 (=)、加號 (+)、減號 (-)、@符號 (@) 。一次呼叫最多支援新增 20 個標籤。	env
Value	string	否	標籤值。最多支援 128 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或`https://`。支援字元包括字母、數字、底線 (_)、點 (.)、冒號 (:)、斜線 (/)、等號 (=)、加號 (+)、減號 (-)、@符號 (@) 。一次呼叫最多支援新增 20 個標籤。	product

返回參數

名稱	類型	描述	樣本值
	object	建立伺服器群組。
JobId	string	非同步任務 ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	請求 ID。	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	伺服器群組 ID。	sgp-atstuj3rtoptyui****

樣本

正常返回樣本

JSON格式

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParam.AnyPortServerGroupConflictWithHealthCheckConfig	The param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal.	伺服器群組的設定與健康檢查設定衝突。請檢查設定參數。
400	IllegalParamFormat.ParseCreateRsPoolRequestFailed	The param format of CreateRsPoolRequest is illegal.	CreateRsPoolRequestFailed的參數格式不合法，請參考OpenAPI文件檢查請求參數。
400	IllegalParam.PreserveClientIpSwitch	The param of PreserveClientIpSwitch is illegal.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.	使用的 VPC 不支援 IPv6。
400	IllegalParam.healthCheckDomain	The parameter of healthCheckConfig.healthCheckDomain is illegal.	健康檢查設定中的 healthCheckDomain 非法，請檢查輸入參數。
400	OperationDenied.UidNotAllowQuic29	The operation is not allowed because of uid not allow quic29 version.
400	IlleagalParam.healthCheckUrl	The parameter of healthCheckUrl in healthCheckConfig is illegal.	健康檢查設定中使用的健康檢查 url 不合法。
400	IllegalParam.ServerGroupName	The param of ServerGroupName is illegal.	傳入的ServerGroupName參數非法。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	dryRun 請求驗證已通過。
400	MissingParam.%s	The parameter of %s is missing.	參數%s缺失，請檢查輸入參數。
400	IllegalParam.ConnectionDrainTimeout	The param of ConnectionDrainTimeout is illegal.	參數 ConnectionDrainTimeout 非法，請檢查輸入參數。
400	IllegalParam	The param of %s is illegal.	輸入的參數有值非法，請檢查輸入。
400	SystemBusy	System is busy, please try again later.	系統繁忙，請稍後重試。
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.	配額不足，已使用 %s/%s。請在配額中心中修改配額大小。
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	因為帳號沒有權限，所以授權失敗。
404	ResourceNotFound.Vpc	The specified resource of Vpc is not found.	找不到指定的 VPC 資源，請檢查輸入參數。
404	ResourceNotFound.ResourceGroup	The param of resourceGroup not existed.	資源群組不存在。

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

變更歷史

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