創建負載均衡監聽器。
接口說明
CreateListener 接口屬于異步接口，即系統返回一個請求 ID，但該監聽尚未創建成功，系統后臺的創建任務仍在進行。您可以調用 GetListenerAttribute 查詢監聽的創建狀態：
-
當監聽處于 Provisioning 狀態時，表示監聽正在創建中。
-
當監聽處于 Running 狀態時，表示 監聽創建成功。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| gwlb:CreateListener | create |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| LoadBalancerId | string | 是 | 網關型負載均衡實例的 ID。 | gwlb-te609d6696632f7***** |
| ListenerDescription | string | 否 | 自定義監聽描述。 長度限制為 2~256 個字符，支持中文和英文字母，可包含數字、半角逗號（,）、半角句號（.）、半角分號（;）、正斜線（/）、at（@）、下劃線（_）和短劃線（-）。 | listener-description |
| ServerGroupId | string | 是 | 服務器組 ID。 | sgp-ckh01px70dszof**** |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值：
| false |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-42665544**** |
| Tag | array<object> | 否 | 標簽列表。一次調用最多支持添加 20 個標簽。 | |
| TagModel | object | 否 | 標簽。 | |
| Key | string | 否 | 標簽鍵。一旦傳入該值，則不允許為空字符串。最多支持 128 個字符，不能以 | testKey |
| Value | string | 否 | 標簽值。最多支持 256 個字符，不能包含 | testValue |
返回參數
示例
正常返回示例
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. | 負載均衡實例下的監聽數量超過限制，操作不支持 |
| 400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | 資源%s當前狀態%s不支持操作 |
| 400 | ResourceInUse.IP | The specified resource of IP is in use. | 指定的IP地址已被使用 |
| 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. | 標簽值參數不合法 |
| 404 | ResourceNotFound.LoadBalancer | The specified resource of %s is not found. | 指定的負載均衡資源不存在 |
| 404 | ResourceNotFound.ServerGroup | The specified resource of %s is not found. | 指定的服務器組資源不存在。 |
訪問錯誤中心查看更多錯誤碼。