在網絡型負載均衡實例中創建TCP、UDP或TCPSSL監聽。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
nlb:CreateListener | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ListenerProtocol | string | 是 | 監聽協議。取值:TCP、UDP 或 TCPSSL。 | TCP |
ListenerPort | integer | 是 | 監聽端口。取值范圍:0~65535。 0:表示使用全端口功能。當設置為 0 時,您需要配置 StartPort 和 EndPort。 | 80 |
ListenerDescription | string | 否 | 自定義監聽名稱。 長度限制為 2~256 個字符,支持中文和英文字母,可包含數字、半角逗號(,)、半角句號(.)、半角分號(;)、正斜線(/)、at(@)、下劃線(_)和短劃線(-)。 | tcp_80 |
LoadBalancerId | string | 是 | 網絡型負載均衡實例 ID。 | nlb-83ckzc8d4xlp8o**** |
ServerGroupId | string | 是 | 服務器組 ID。 說明
| sgp-ppdpc14gdm3x4o**** |
IdleTimeout | integer | 否 | 連接空閑超時時間。單位:秒。
| 900 |
SecurityPolicyId | string | 否 | 安全策略 ID。支持系統安全策略和自定義安全策略。
說明
僅對 TCPSSL 監聽生效。
| tls_cipher_policy_1_0 |
CertificateIds | array | 否 | 服務器證書列表信息。僅對 TCPSSL 監聽生效。 說明
目前僅支持添加 1 個服務器證書。
| |
CertificateId | string | 否 | 服務器證書列表信息。僅對 TCPSSL 監聽生效。 說明
目前僅支持添加 1 個服務器證書。
| 123157****** |
CaCertificateIds | array | 否 | CA 證書列表。僅對 TCPSSL 監聽生效。 說明
目前僅支持添加 1 個 CA 證書。
| |
CaCertificateId | string | 否 | CA 證書列表。僅對 TCPSSL 監聽生效。 說明
目前僅支持添加 1 個 CA 證書。
| 139a00****** |
CaEnabled | boolean | 否 | 是否啟動雙向認證。取值:
| false |
DryRun | boolean | 否 | 是否只預檢此次請求。取值:
| false |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
RegionId | string | 否 | 網絡型負載均衡實例所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
ProxyProtocolEnabled | boolean | 否 | 是否開啟通過 Proxy Protocol 協議攜帶客戶端源地址到后端服務器。取值:
| false |
SecSensorEnabled | boolean | 否 | 是否開啟秒級監控功能。取值:
| false |
AlpnEnabled | boolean | 否 | 是否開啟 ALPN。取值:
| false |
AlpnPolicy | string | 否 | ALPN 策略。取值:
說明
AlpnEnabled 開啟后需配置該參數。
| HTTP1Only |
StartPort | integer | 否 | 全端口監聽起始端口。取值范圍:0 ~ 65535。 說明
當 ListenerPort 為 0 時,需要配置該參數。
| 244 |
EndPort | integer | 否 | 全端口監聽結束端口。取值范圍:0 ~ 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 個字符,不能以 一次調用最多支持添加 20 個標簽。 | KeyTest |
Value | string | 否 | 標簽值。最多支持 128 個字符,不能以 一次調用最多支持添加 20 個標簽。 | Test |
ProxyProtocolV2Config | object | 否 | 通過 Proxy Protocol 協議攜帶 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服務器配置。 | |
Ppv2VpcIdEnabled | boolean | 否 | 是否開啟通過 Proxy Protocol 協議攜帶 VpcId 到后端服務器。取值:
| false |
Ppv2PrivateLinkEpIdEnabled | boolean | 否 | 是否開啟通過 Proxy Protocol 協議攜帶 Ppv2PrivateLinkEpId 到后端服務器。取值:
| false |
Ppv2PrivateLinkEpsIdEnabled | boolean | 否 | 是否開啟通過 Proxy Protocol 協議攜帶 PrivateLinkEpsId 到后端服務器。取值:
| false |
返回參數
示例
正常返回示例
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 不存在,請檢查輸入參數。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-03-21 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-03-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-02-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-02-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-11-27 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-10-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-10-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-05 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-06-30 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2023-06-29 | OpenAPI 入參發生變更 | 查看變更詳情 |