創(chuàng)建UDP監(jiān)聽。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
slb:CreateLoadBalancerUDPListener | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 傳統(tǒng)型負載均衡實例的地域 ID。 | cn-hangzhou |
Tag | array<object> | 否 | 監(jiān)聽的標簽集合。 | |
object | 否 | 監(jiān)聽的標簽集合。 | ||
Key | string | 否 | 監(jiān)聽的標簽鍵。N 的取值范圍:1~20。一旦傳入該值,則不允許為空字符串。最多支持 128 個字符,不能以 | TestKey |
Value | string | 否 | 監(jiān)聽的標簽值。N 的取值范圍:1~20。一旦傳入該值,可以為空字符串。最多支持 128 個字符,不能以 | TestValue |
LoadBalancerId | string | 是 | 傳統(tǒng)型負載均衡實例的 ID。 | lb-bp1ygod3yctvg1y7**** |
ListenerPort | integer | 是 | 傳統(tǒng)型負載均衡實例前端使用的端口。 取值范圍:1~65535。 | 80 |
BackendServerPort | integer | 否 | 傳統(tǒng)型負載均衡實例后端使用的端口。 取值范圍:1~65535。 如果不使用虛擬服務器組(不指定 VServerGroupId),則該參數(shù)必選。 | 80 |
Bandwidth | integer | 是 | 監(jiān)聽的帶寬峰值。單位:Mbps。取值:
| -1 |
Scheduler | string | 否 | 調(diào)度算法。取值:
僅性能保障型實例支持 sch、 tch 和 qch 一致性 hash 算法。 | wrr |
HealthyThreshold | integer | 否 | 健康檢查連續(xù)成功多少次后,將后端服務器的健康檢查狀態(tài)由 fail 判定為 success。 取值范圍:2~10。 | 4 |
UnhealthyThreshold | integer | 否 | 健康檢查連續(xù)失敗多少次后,將后端服務器的健康檢查狀態(tài)由 success 判定為 fail。 取值范圍:2~10。 | 4 |
HealthCheckConnectTimeout | integer | 否 | 接收來自運行狀況檢查的響應需要等待的時間。 如果后端 ECS 在指定的時間內(nèi)沒有正確響應,則判定為健康檢查失敗。單位:秒。 取值范圍:1~300。 | 100 |
HealthCheckConnectPort | integer | 否 | 健康檢查使用的端口。 取值范圍:1~65535。 不設置此參數(shù)時,表示使用后端服務端口(BackendServerPort)。 | 80 |
healthCheckInterval | integer | 否 | 健康檢查的時間間隔。單位:秒。 取值范圍:1~50。 | 3 |
healthCheckReq | string | 否 | UDP 監(jiān)聽健康檢查的請求字符串,只允許包含字母、數(shù)字,最大長度限制為 64 個字符。 | hello |
healthCheckExp | string | 否 | UDP 監(jiān)聽健康檢查的響應字符串,只允許包含字母、數(shù)字,最大長度限制為 64 個字符。 | ok |
VServerGroupId | string | 否 | 虛擬服務器組 ID。 | rsp-cige6j8**** |
MasterSlaveServerGroupId | string | 否 | 主備服務器組 ID。 說明
虛擬服務器組 ID 和主備服務器組 ID 只能選擇一個。
| rsp-0bfucwu**** |
AclId | string | 否 | 監(jiān)聽綁定的訪問策略組 ID。 當 AclStatus 參數(shù)的值為 on 時,該參數(shù)必選。 | acl-uf60jw*** |
AclType | string | 否 | 訪問控制類型,取值:
當 AclStatus 參數(shù)的值為 on 時,該參數(shù)有效。 | white |
AclStatus | string | 否 | 是否開啟訪問控制功能。取值:
| off |
Description | string | 否 | 自定義監(jiān)聽名稱。 長度限制為 1~256 個字符,支持中文、字母、數(shù)字、短劃線(-)、正斜線(/)、半角句號(.)和下劃線(_)。 | udp_80 |
ProxyProtocolV2Enabled | boolean | 否 | 是否支持通過 Proxy Protocol 協(xié)議攜帶客戶端源地址到后端服務器。取值:
| false |
HealthCheckSwitch | string | 否 | 是否開啟健康檢查。取值:
| on |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75556"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameterValue.SpecNotSupport | The loadBalancer of shared spec does not support the parameter value, %s. | 共享型負載均衡實例不支持指定的參數(shù)取值。 |
400 | OperationNotSupport.Acl | The cloud box instance does not support acl. | 云盒實例不支持配置訪問控制。 |
400 | InvalidParameterValue.RegionNotSupport | The region does not support the parameter value, %s. | 當前地域不支持指定的參數(shù)取值。 |
400 | Abs.VServerGroupIdAndMasterSlaveServerGroupId.MissMatch | The parameters VServerGroupId or MasterSlaveServerGroupId miss match. | 參數(shù)VServerGroupId或MasterSlaveServerGroupId不匹配。 |
400 | IpVersionConflict | The ip version of this LoadBalancer and the Acl is conflict. | 指定負載均衡的IP版本與ACL支持的IP類型沖突。 |
400 | InvalidParameterValue.ZoneNotSupport | The zone does not support the parameter value, %s. | 當前可用區(qū)不支持指定參數(shù)取值。 |
400 | ListenerProcessing | A previous configuration of the listener is pending,please try again later. | 當前監(jiān)聽正在配置中,請稍后重試。 |
400 | AclNotExist | Acl does not exist. | 指定的Acl不存在。 |
400 | InvalidParameter.ListenerPortConflict | There is conflict listener port exists. | 指定的監(jiān)聽端口已存在。 |
400 | InvalidParam.VServerGroupId | The specified VServerGroupId is invalid. | 指定的VServerGroupId無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | MissingParam.HealthCheckConnectPort | The parameter HealthCheckConnectPort is required. | 參數(shù)HealthCheckConnectPort缺失。 |
400 | InvalidParam.ListenerPort | The specified ListenerPort is invalid. | 指定的ListenerPort無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | InvalidParam.StartPort | The specified StartPort is invalid. | 指定的StartPort無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | InvalidParamSize.PortRange | The size of param PortRange is invalid. | 指定的PortRange無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | InvalidParam.EndPort | The specified EndPort is invalid. | 指定的EndPort無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | QuotaLimitExceeds.AclAttachedToListener | %s. | - |
400 | QuotaLimitExceeds.TotalAclEntry | %s. | - |
400 | AclListenerOverLimit | %s. | - |
400 | Duplicated.AclEntry | %s. | Acl條目重復。 |
400 | InvalidParameter.RegionNotSupport | The region does not support the parameter: %s. | 當前區(qū)域不支持指定參數(shù)。 |
400 | LbNotSupportTcpssl | You cannot create a TCP SSL type listener for the specified load balancer. | 指定的實例不支持創(chuàng)建tcpssl類型的監(jiān)聽。 |
400 | LbSupportTcpsslOnly | The specified load balancer supports TCP SSL type listener only. | 指定的實例只支持創(chuàng)建tcpssl類型的監(jiān)聽。 |
400 | ListenerNotSupportRule | You cannot create a rule for the specified listener. | 指定的監(jiān)聽不支持創(chuàng)建轉(zhuǎn)發(fā)規(guī)則。 |
400 | InvalidParamLength.HealthCheckExp | The length of the parameter HealthCheckReq is invalid. | 指定的HealthCheckExp無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | InvalidParamLength.HealthCheckReq | The length of the parameter HealthCheckReq is invalid. | 指定的HealthCheckReq無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | InvalidParam.HealthCheckReq | The param HealthCheckReq is invalid. | 指定的HealthCheckReq無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | InvalidParam.HealthCheckExp | The param HealthCheckExp is invalid. | 指定的HealthCheckExp無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | ResourceNotFound.VServerGroup | %s. | 指定的服務器組不存在。 |
400 | IllegalParam.FailoverThreshold | The parameter FailoverThreshold is illegal. | 指定的FailoverThreshold無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | IllegalParam.FailoverStrategy | The parameter FailoverStrategy is illegal. | 指定的FailoverStrategy無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | InvalidParameter.ZoneNotSupport | The zone does not support the parameter %s. | 當前可用區(qū)不支持指定參數(shù)。 |
400 | MasterSlaveServerConflict | The servers are conflict for MasterSlaveGroup. | 主備服務器組的后端服務器沖突。 |
400 | VipNotSupportQuicVersion | The listener does not support the parameter of QuicVersion. | 當前監(jiān)聽不支持QuicVersion參數(shù)。 |
400 | IllegalParam.HealthCheckType | The param of HealthCheckType is illegal. | 指定的HealthCheckType無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | MissingParam.HealthCheckMethod | The param of HealthCheckMethod is missing. | 參數(shù)HealthCheckMethod缺失。 |
400 | IllegalParam.HealthCheckMethod | The param of HealthCheckMethod is illegal. | 指定的HealthCheckMethod無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | IllegalParam.HealthCheck | The param of HealthCheck is illegal. | 指定的HealthCheck無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | OperationDenied.SpecialListenerPortNotAllowed | The operation is not allowed because port 4789 is reserved by the system. | 操作被拒絕,原因是4789是系統(tǒng)保留端口。 |
400 | Mismatch.SlbSpecTypeAndListenerProtocol | The SlbSpecType and ListenerProtocol are mismatched. | 實例規(guī)格類型和監(jiān)聽類型不匹配。 |
400 | OperationDenied.OnlyIpv4SlbSupport | The operation is not allowed because of OnlyIpv4SlbSupport. | 操作被拒絕,原因是只有IPV4實例支持開啟FULL NAT模式。 |
400 | OperationDenied.FullNatModeNotAllowed | The operation is not allowed because of FullNatModeNotAllowed. | 操作被拒絕,原因是不支持FullNat模式。 |
400 | SpecNotSupportParameter | The instance with share spec does not support FullNatEnabled parameter. | 共享型實例不支持FullNatEnabled參數(shù)。 |
400 | InvalidParam.TagValue | %s. | - |
400 | InvalidParam.TagKey | %s. | - |
400 | SizeLimitExceeded.Tag | %s. | - |
400 | MissingParam.TagKey | The param MissingParam.TagKey is missing. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-06-02 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |