修改UDP協議監聽的配置。
接口說明
- 您已經創建傳統型負載均衡,具體操作,請參見 CreateLoadBalancer 。
- 您已經創建 UDP 監聽,具體操作,請參見 CreateLoadBalancerUDPListener 。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
slb:SetLoadBalancerUDPListenerAttribute | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 傳統型負載均衡實例的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
LoadBalancerId | string | 是 | 傳統型負載均衡實例的 ID。 | lb-bp1rtfnodmywb43ecu4sf-c**** |
ListenerPort | integer | 是 | 傳統型負載均衡實例前端使用的端口。 取值范圍:1~65535。 | 80 |
Bandwidth | integer | 否 | 監聽的帶寬峰值,單位:Mbps。取值:
| -1 |
Scheduler | string | 否 | 調度算法。取值:
說明
| wrr |
HealthyThreshold | integer | 否 | 健康檢查連續成功多少次后,將后端服務器的健康檢查狀態由 fail 判定為 success。 取值范圍:1~10。 | 4 |
UnhealthyThreshold | integer | 否 | 健康檢查連續失敗多少次后,將后端服務器的健康檢查狀態由 success 判定為 fail。 取值范圍:1~10。 | 4 |
HealthCheckConnectTimeout | integer | 否 | 接收來自運行狀況檢查的響應需要等待的時間。如果后端 ECS 在指定的時間內沒有正確響應,則判定為健康檢查失敗。單位:秒。 取值范圍:1~300。 說明
如果 HealthCheckConnectTimeout 的值小于 HealthCheckInterval 的值,則 HealthCheckConnectTimeout 無效,超時時間為 HealthCheckInterval 的值。
| 100 |
HealthCheckConnectPort | integer | 否 | 健康檢查使用的端口。 取值范圍:1~65535。 | 80 |
HealthCheckInterval | integer | 否 | 健康檢查的時間間隔,單位:秒。 取值范圍:1~50。 | 5 |
healthCheckReq | string | 否 | UDP 監聽健康檢查的請求串,只允許包含字母、數字,最大長度限制為 64 個字符。 | hello |
healthCheckExp | string | 否 | UDP 監聽健康檢查的響應串,只允許包含字母、數字,最大長度限制為 64 個字符。 | ok |
VServerGroup | string | 否 | 是否使用虛擬服務器組。取值:
說明
VserverGroup 和 MasterSlaveServerGroup 只允許一個值為 on。
| on |
VServerGroupId | string | 否 | 虛擬服務器組 ID。 | rsp-cige6**** |
MasterSlaveServerGroupId | string | 否 | 主備服務器組 ID。 說明
虛擬服務器組 ID 和主備服務器組 ID 只能選擇一個。
| rsp-0bfuc**** |
MasterSlaveServerGroup | string | 否 | 是否使用主備服務器組。取值:
說明
VserverGroup 和 MasterSlaveServerGroup 只允許取值為 on。
| on |
AclId | string | 否 | 監聽綁定的訪問策略組 ID。 說明
當 AclStatus 參數的值為 on 時,該參數必選。
| off |
AclType | string | 否 | 訪問控制類型。取值:
說明
當 AclStatus 參數的值為 on 時,該參數有效。
| white |
AclStatus | string | 否 | 是否開啟訪問控制功能。取值:
| off |
Description | string | 否 | 自定義監聽名稱。 長度限制為 1~256 個字符,支持中文、字母、數字、短劃線(-)、正斜線(/)、半角句號(.)和下劃線(_)。 | udp_80 |
ProxyProtocolV2Enabled | boolean | 否 | 是否支持通過 Proxy Protocol 協議攜帶客戶端源地址到后端服務器。取值:
| false |
HealthCheckSwitch | string | 否 | 是否開啟健康檢查。取值:
| on |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameterValue.SpecNotSupport | The loadBalancer of shared spec does not support the parameter value, %s. | 共享型負載均衡實例不支持指定的參數取值。 |
400 | OperationNotSupport.Acl | The cloud box instance does not support acl. | 云盒實例不支持配置訪問控制。 |
400 | InvalidParameterValue.RegionNotSupport | The region does not support the parameter value, %s. | 當前地域不支持指定的參數取值。 |
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. | 當前可用區不支持指定參數取值。 |
400 | OperationFailed.ServerGroupInUse | The VServerGroup or MasterSlaveServerGroup can not be close for this listener. | 操作失敗,原因是當前監聽不支持關閉服務器組。 |
400 | InvalidParam.VServerGroupId | The specified VServerGroupId is invalid. | 指定的VServerGroupId無效。請檢查參數約束,并在修改后重試。 |
400 | MissingParam.HealthCheckConnectPort | The parameter HealthCheckConnectPort is required. | 參數HealthCheckConnectPort缺失。 |
400 | InvalidParam.ListenerPort | The specified ListenerPort is invalid. | 指定的ListenerPort無效。請檢查參數約束,并在修改后重試。 |
400 | InvalidParam.StartPort | The specified StartPort is invalid. | 指定的StartPort無效。請檢查參數約束,并在修改后重試。 |
400 | InvalidParamSize.PortRange | The size of param PortRange is invalid. | 指定的PortRange無效。請檢查參數約束,并在修改后重試。 |
400 | InvalidParam.EndPort | The specified EndPort is invalid. | 指定的EndPort無效。請檢查參數約束,并在修改后重試。 |
400 | InvalidParam.PortRange | The specified PortRange is invalid. | 指定的PortRange無效。請檢查參數約束,并在修改后重試。 |
400 | QuotaLimitExceeds.AclAttachedToListener | %s. | - |
400 | QuotaLimitExceeds.TotalAclEntry | %s. | - |
400 | AclListenerOverLimit | %s. | - |
400 | Duplicated.AclEntry | %s. | Acl條目重復。 |
400 | InvalidParamLength.HealthCheckReq | The length of the parameter HealthCheckReq is invalid. | 指定的HealthCheckReq無效。請檢查參數約束,并在修改后重試。 |
400 | InvalidParamLength.HealthCheckExp | The length of the parameter HealthCheckExp is invalid. | 指定的HealthCheckExp無效。請檢查參數約束,并在修改后重試。 |
400 | InvalidParam.HealthCheckReq | The param HealthCheckReq is invalid. | 指定的HealthCheckReq無效。請檢查參數約束,并在修改后重試。 |
400 | InvalidParam.HealthCheckExp | The param HealthCheckExp is invalid. | 指定的HealthCheckExp無效。請檢查參數約束,并在修改后重試。 |
400 | ResourceNotFound.VServerGroup | %s. | 指定的服務器組不存在。 |
400 | IllegalParam.FailoverThreshold | The parameter FailoverThreshold is illegal. | 指定的FailoverThreshold無效。請檢查參數約束,并在修改后重試。 |
400 | IllegalParam.FailoverStrategy | The parameter FailoverStrategy is illegal. | 指定的FailoverStrategy無效。請檢查參數約束,并在修改后重試。 |
400 | InvalidParameter.ZoneNotSupport | The zone does not support the parameter %s. | 當前可用區不支持指定參數。 |
400 | MasterSlaveServerConflict | The servers are conflict for MasterSlaveGroup. | 主備服務器組的后端服務器沖突。 |
400 | MissingParam.VServerGroupId | The parameter VServerGroupId is missing. | 參數VServerGroupId缺失。 |
400 | VipNotSupportQuicVersion | The listener does not support the parameter of QuicVersion. | 當前監聽不支持QuicVersion參數。 |
400 | IllegalParam.HealthCheckType | The param of HealthCheckType is illegal. | 指定的HealthCheckType無效。請檢查參數約束,并在修改后重試。 |
400 | IllegalParam.HealthCheckMethod | The param of HealthCheckMethod is illegal. | 指定的HealthCheckMethod無效。請檢查參數約束,并在修改后重試。 |
400 | IllegalParam.HealthCheck | The param of HealthCheck is illegal. | 指定的HealthCheck無效。請檢查參數約束,并在修改后重試。 |
400 | OperationDenied.MasterSlaveGroupLogEnabled | The operation is denied because of MasterSlaveGroupLogEnabled. | 操作被拒絕,原因是主備服務器組日志已啟用。 |
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參數。 |
400 | Abs.VServerGroupIdAndMasterSlaveServerGroupId.MissMatch | Virtual service group ID or master slave server group ID is missing. Please check the input parameters. | 虛擬服務組ID或者主備服務器組ID缺失,請檢查輸入參數。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-09-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |