CreateListener - 建立監聽 - Server Load Balancer

建立負載平衡監聽器。

介面說明

CreateListener 介面屬於非同步介面，即系統返回一個請求 ID，但該監聽尚未建立成功，系統背景建立任務仍在進行。您可以調用 GetListenerAttribute 查詢監聽的建立狀態：

當監聽處於 Provisioning 狀態時，表示監聽正在建立中。
當監聽處於 Running 狀態時，表示監聽建立成功。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

gwlb:CreateListener

create

*LoadBalancer

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

*ServerGroup

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

*Listener

acs:gwlb:{#regionId}:{#accountId}:listener/*

無

請求參數

名稱	類型	必填	描述	樣本值
LoadBalancerId	string	是	網關型Server Load Balancer執行個體的 ID。	gwlb-te609d6696632f7*****
ListenerDescription	string	否	自訂監聽描述。長度限制為 2~256 個字元，支援中文和英文字母，可包含數字、半形逗號（,）、半形句號（.）、半形分號（;）、正斜線（/）、at（@）、底線（_）和短劃線（-）。	listener-description
ServerGroupId	string	是	伺服器組 ID。	sgp-ckh01px70dszof****
TcpIdleTimeout	integer	否	TCP 串連空閑逾時時間。取值範圍：60-6000 秒。預設值：350 秒。	350
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會建立監聽。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行操作。	false
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	123e4567-e89b-12d3-a456-42665544****
Tag	array<object>	否	標籤列表。一次調用最多支援添加 20 個標籤。
	object	否	標籤。
Key	string	否	標籤鍵。一旦傳入該值，則不允許為空白字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	testKey
Value	string	否	標籤值。最多支援 256 個字元，不能包含`http://`或`https://`。	testValue

返回參數

名稱	類型	描述	樣本值
	object	請求的傳回值。
ListenerId	string	監聽 ID。	lsn-wi3c0v30ivysrg****
RequestId	string	請求 ID。	A045E652-D298-5E70-A978-7247135336FB

樣本

正常返回樣本

JSON格式

{
  "ListenerId": "lsn-wi3c0v30ivysrg****",
  "RequestId": "A045E652-D298-5E70-A978-7247135336FB"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	資源%s業務狀態%s不支援當前操作
400	MissingParam.TagKey	The param of TagKey is missing.	標籤鍵參數缺失
400	MissingParam.TagValue	The param of TagValue is missing.	標籤值參數缺失
400	OperationDenied.TooManyListeners	The operation is not allowed because of TooManyListener.	Server Load Balancer執行個體下的監聽數量超過限制，操作不支援
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	資源%s目前狀態%s不支援操作
400	ResourceInUse.IP	The specified resource of IP is in use.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	兩個資源的VPC ID不匹配
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	資源%s目前狀態%s不支援操作
400	DuplicatedParam.TagKey	The param of %s is duplicated.	標籤鍵參數重複
400	IllegalParam.TagKey	The param of %s is illegal.
400	IllegalParam.TagValue	The param of %s is illegal.	標籤值參數不合法
400	OperationDenied.TcpIdleTimeoutConflictWithScheduler	The TCP idle timeout of listener must be default value when the scheduling algorithm of server group is not 5TCH.	配置衝突，自訂配置了的TCP串連空閑逾時時間，伺服器組的調度演算法需要使用五元組雜湊。
404	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.	指定的負載平衡資源不存在
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	指定的伺服器組資源不存在。

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

變更歷史

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