CreateListener - 建立監聽 - Server Load Balancer

在網路型Server Load Balancer執行個體中建立TCP、UDP或TCPSSL監聽。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

nlb:CreateListener

create

*ServerGroup

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

SecurityPolicy

acs:nlb:{#regionId}:{#accountId}:securitypolicy/{#SecurityPolicyId}

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}

nlb:ListenerProtocol
nlb:SecurityPolicyId

無

請求參數

名稱	類型	必填	描述	樣本值
ListenerProtocol	string	是	監聽協議。取值：TCP、UDP 或 TCPSSL。	TCP
ListenerPort	integer	是	監聽連接埠。取值範圍：0~65535。 0：表示使用全連接埠功能。當設定為 0 時，您需要配置 StartPort 和 EndPort。	80
ListenerDescription	string	否	自訂監聽名稱。長度限制為 2~256 個字元，支援中文和英文字母，可包含數字、半形逗號（,）、半形句號（.）、半形分號（;）、正斜線（/）、at（@）、底線（_）和短劃線（-）。	tcp_80
LoadBalancerId	string	是	網路型Server Load Balancer執行個體 ID。	nlb-83ckzc8d4xlp8o****
ServerGroupId	string	是	伺服器組 ID。說明當 ListenerProtocol 取值為 TCP 時，該監聽支援選擇後端協議為 TCP 或者TCP_UDP的伺服器組，不支援選擇後端協議為 UDP 的伺服器組。當 ListenerProtocol 取值為 UDP 時，該監聽支援選擇後端協議為 UDP 或者TCP_UDP的伺服器組，不支援選擇後端協議為 TCP 的伺服器組。當 ListenerProtocol 取值為 TCPSSL 時，該監聽支援選擇後端協議為 TCP 且未開啟用戶端地址保持功能的伺服器組，不支援選擇後端協議為 TCP 且開啟用戶端地址保持功能的伺服器組、後端協議為 UDP 或者TCP_UDP的伺服器組。	sgp-ppdpc14gdm3x4o****
IdleTimeout	integer	否	串連空閑逾時時間。單位：秒。當 ListenerProtocol 取值為 TCP 或 TCPSSL 時，串連空閑逾時時間取值範圍為：10~900。預設值：900。當 ListenerProtocol 取值為 UDP 時，串連空閑逾時時間取值範圍為：10~90。預設值：90。	900
SecurityPolicyId	string	否	安全性原則 ID。支援系統安全性原則和自訂安全性原則。系統策略取值：tls_cipher_policy_1_0（預設值）、tls_cipher_policy_1_1、tls_cipher_policy_1_2、tls_cipher_policy_1_2_strict或tls_cipher_policy_1_2_strict_with_1_3。自訂安全性原則：輸入自訂安全性原則 ID。建立自訂策略，請參見 CreateSecurityPolicy 。查詢安全性原則，請參見 ListSecurityPolicy 。說明僅對 TCPSSL 監聽生效。	tls_cipher_policy_1_0
CertificateIds	array	否	伺服器憑證列表資訊。僅對 TCPSSL 監聽生效。說明目前僅支援添加 1 個伺服器憑證。
	string	否	伺服器憑證列表資訊。僅對 TCPSSL 監聽生效。說明目前僅支援添加 1 個伺服器憑證。	123157******
CaCertificateIds	array	否	CA 憑證列表。僅對 TCPSSL 監聽生效。說明目前僅支援添加 1 個 CA 憑證。
	string	否	CA 憑證列表。僅對 TCPSSL 監聽生效。說明目前僅支援添加 1 個 CA 憑證。	139a00******
CaEnabled	boolean	否	是否啟動雙向認證。取值： true：啟動。 false（預設值）：關閉。	false
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會建立監聽。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行操作。	false
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	123e4567-e89b-12d3-a456-426655440000
RegionId	string	否	網路型Server Load Balancer執行個體所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
ProxyProtocolEnabled	boolean	否	是否開啟通過 Proxy Protocol 協議攜帶用戶端源地址到後端伺服器。取值： true：開啟。 false（預設值）：關閉。	false
SecSensorEnabled	boolean	否	是否開啟秒級監控功能。取值： true：開啟。 false（預設值）：關閉。	false
AlpnEnabled	boolean	否	是否開啟 ALPN。取值： true：開啟。 false（預設值）：關閉。	false
AlpnPolicy	string	否	ALPN 策略。取值： HTTP1Only：只協商使用 HTTP1.x 協議，優先順序為 HTTP1.1>HTTP1.0。 HTTP2Only：只協商使用 HTTP2.0 協議。 HTTP2Optional：優先使用 HTTP1.x 協議，但也接受 HTTP2.0 協議，優先順序為 HTTP1.1>HTTP1.0>HTTP2.0。 HTTP2Preferred：優先使用 HTTP2.0 協議，但也接受 HTTP1.x 協議，優先順序為 HTTP2.0>HTTP1.1>HTTP1.0。說明 AlpnEnabled 開啟後需配置該參數。	HTTP1Only
StartPort	integer	否	全連接埠監聽開始端點口。取值範圍：1 ~ 65535。說明當 ListenerPort 為 0 時，需要配置該參數。	244
EndPort	integer	否	全連接埠監聽結束連接埠。取值範圍：1 ~ 65535。終止連接埠的取值大於開始端點口。說明當 ListenerPort 為 0 時，需要配置該參數。	566
Cps	integer	否	該監聽在每個可用性區域（VIP）處理的每秒建立串連限速值。取值範圍：0~1000000。0 表示不限速。	100
Mss	integer	否	TCP 報文的最大段大小。單位：位元組，取值範圍：0~1500。 0：表示不修改使用者 TCP 報文的 MSS 值。說明僅 TCP、TCPSSL 類型的監聽支援該欄位值。	43
Tag	array<object>	否	標籤列表。
	object	否	標籤。
Key	string	否	標籤鍵。最多支援 64 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或`https://`。支援字元包括字母、數字、底線 (_)、點 (.)、冒號 (:)、斜線 (/)、等號 (=)、加號 (+)、減號 (-)、@符號 (@) 。一次調用最多支援添加 20 個標籤。	KeyTest
Value	string	否	標籤值。最多支援 128 個字元，不能以`aliyun`或`acs:`開頭，不能包含`http://`或`https://`。支援字元包括字母、數字、底線 (_)、點 (.)、冒號 (:)、斜線 (/)、等號 (=)、加號 (+)、減號 (-)、@符號 (@) 。一次調用最多支援添加 20 個標籤。	Test
ProxyProtocolV2Config	object	否	通過 Proxy Protocol 協議攜帶 VpcId、PrivateLinkEpId、PrivateLinkEpsId 資訊到後端伺服器配置。
Ppv2VpcIdEnabled	boolean	否	是否開啟通過 Proxy Protocol 協議攜帶 VpcId 到後端伺服器。取值： true：開啟。 false（預設值）：關閉。	false
Ppv2PrivateLinkEpIdEnabled	boolean	否	是否開啟通過 Proxy Protocol 協議攜帶 Ppv2PrivateLinkEpId 到後端伺服器。取值： true：開啟。 false（預設值）：關閉。	false
Ppv2PrivateLinkEpsIdEnabled	boolean	否	是否開啟通過 Proxy Protocol 協議攜帶 PrivateLinkEpsId 到後端伺服器。取值： true：開啟。 false（預設值）：關閉。	false

返回參數

名稱	類型	描述	樣本值
	object	RpcResponse
RequestId	string	請求 ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
ListenerId	string	監聽 ID。	lsn-bp1bpn0kn908w4nbw****@80
JobId	string	非同步任務 ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ListenerId": "lsn-bp1bpn0kn908w4nbw****@80",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Conflict.Port	The Port [%s] is conflict.	指定連接埠與已有連接埠存在衝突
400	IllegalParam.MssConflictWithUdpAndGeneve	The param of MssConflictWithUdpAndGeneve is illegal.	Mss值不為null時，listenerProtocol不可以是udp或者GENEVE。
400	QuotaExceeded.%s	The quota of %s is exceeded, usage %s/%s.	%s的配額超過限制，已使用%s/%s
400	SystemBusy	System is busy, please try again later.	系統繁忙，請稍後重試
400	Mismatch.VpcId	The VpcId is mismatched for %s and %s.	資源%s和資源%s的VpcId不匹配。請檢查兩種資源是否在同一個VPC下。
400	ResourceNotEnough.%s	The specified resource of %s is not enough.	所需要的資源%s不足了
400	Conflict.Lock	The Lock [%s] is conflict.	指定的資源當前存在鎖衝突。
400	IllegalParam.AnyPortListenerConflictWithNonAnyPortServerGroup	The param of AnyPortListenerConflictWithNonAnyPortServerGroup is illegal.	servergroup的全連接埠轉寄開關，必須匹配與監聽的anyport開關匹配，請檢查參數。
400	IncorrectStatus.loadbalancer	The status of loadbalancer [%s] is incorrect.	負載平衡的狀態無法進行當前操作，請檢查負載平衡當前是否處於其他動作下。
400	ResourceNotFound.Certificate	The specified resource %s is not found.	資源%s不存在。
400	IllegalParam.ServerGroupId	The param of ServerGroupId is illegal.	參數ServerGroupId非法，請檢查輸入參數。
400	IllegalParam.NonAnyPortListenerConflictWithAnyPortServerGroup	The param of NonAnyPortListenerConflictWithAnyPortServerGroup is illegal.	監聽連接埠配置與全連接埠轉寄開關衝突。
400	MissingParam.Certificate	The param of certificate is missing.	參數Certificate缺失。
400	IllegalParam.Port	The param of Port is illegal.	請求中的連接埠範圍非法，請檢查輸入參數。
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.	配額不足，已使用%s/%s。請在配額中心中修改配額大小。
400	Mismatch.Protocol	The Protocol is mismatched for %s and %s.	監聽和伺服器組的協議不匹配。
400	ResourceNotEnough.CaCertificateApiCount	The specified resource of CaCertificateApiCount is not enough.
400	MissingParam.ServerGroupId	The param of ServerGroupId is missing.	參數ServerGroupId缺失，請檢查輸入參數。
400	IllegalParam.ListenerDescription	The parameter ListenerDescription of listener is illegal.	監聽描述不符合輸入要求，請根據錯誤中的詳細資料進行修改。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	dryRun請求驗證已通過。
400	IllegalParam.IdleTimeout	The param of IdleTimeout is illegal.	參數串連空閑逾時時間配置非法。
400	MissingParam.%s	The parameter of %s is missing.	參數%s缺失，請檢查輸入參數。
400	IllegalParam	The param of %s is illegal.	輸入的參數有值非法，請檢查輸入。
400	IllegalParamSize.certificateIds	The param size of certificateIds or caCertificateIds is illegal.	認證的id只能有一個，請檢查是否重複輸入。
400	DuplicatedParam.listener	The param of any port listener is duplicated.	只能建立一個anyport類型監聽，請檢查輸入參數。
400	IllegalParam.PreserveClientIpSwitch	The server group associated with the tcpssl listener does not support enabling PreserveClientIp.	tcpssl監聽關聯的伺服器組不支援開啟用戶端ip保持功能
400	OperationDenied.RegionNotSupportHDMonitor	The operation is not allowed because of RegionNotSupportHDMonitor.	目前範圍不支援秒級監控。
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	因為帳號沒有許可權，所以鑒權失敗。
404	ResourceNotFound.VSwitch	The specified resource of vSwitch is not found.	找不到指定的虛擬交換器資源，請檢查輸入參數。
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	找不到指定的負載平衡器資源，請檢查輸入參數。
404	ResourceNotFound.serverGroup	The specified resource of serverGroup is not found.	找不到指定的伺服器組資源，請檢查輸入參數。
404	ResourceNotFound.CaCertificate	The specified resource of CaCertificate is not found.	Ca認證不存在，請檢查輸入參數。
404	ResourceNotFound.HdMonitorConfigNotExist	The specified resource of HdMonitorConfigNotExist is not found.	HdMonitorConfig 不存在，請檢查輸入參數。

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

變更歷史

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