修改TCP監(jiān)聽的配置。
接口說明
-
您已經(jīng)創(chuàng)建傳統(tǒng)型負載均衡。具體操作,請參見 CreateLoadBalancer 。
-
您已經(jīng)創(chuàng)建 TCP 監(jiān)聽。具體操作,請參見 CreateLoadBalancerTCPListener 。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(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:SetLoadBalancerTCPListenerAttribute | update |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 傳統(tǒng)型負載均衡實例的地域 ID。 您可以從地域和可用區(qū)列表或通過調(diào)用 DescribeRegions 接口查詢地域 ID。 | cn-hangzhou |
LoadBalancerId | string | 是 | 傳統(tǒng)型負載均衡實例 ID。 | lb-bp1ygod3yctvg1y**** |
ListenerPort | integer | 是 | 傳統(tǒng)型負載均衡實例前端使用的端口。 取值范圍:1~65535。 | 80 |
Bandwidth | integer | 否 | 監(jiān)聽的帶寬峰值。單位:Mbps。取值:-1或 1~5120。
| 43 |
Scheduler | string | 否 | 調(diào)度算法。取值:
說明
| wrr |
PersistenceTimeout | integer | 否 | 會話保持的超時時間。單位:秒,取值范圍:0~3600。 默認值:0,表示關(guān)閉會話保持。 | 0 |
EstablishedTimeout | integer | 否 | 連接超時時間。單位:秒。取值范圍:10~900。 | 500 |
HealthyThreshold | integer | 否 | 健康檢查連續(xù)成功多少次后,將后端服務(wù)器的健康檢查狀態(tài)由失敗判定為成功。 取值范圍:2~10。 | 4 |
UnhealthyThreshold | integer | 否 | 健康檢查連續(xù)失敗多少次后,將后端服務(wù)器的健康檢查狀態(tài)由成功判定為失敗。 取值范圍:2~10。 | 4 |
HealthCheckConnectTimeout | integer | 否 | 接收來自運行狀況檢查的響應(yīng)需要等待的時間。單位:秒,取值范圍:1~300。 如果后端 ECS 在指定的時間內(nèi)沒有正確響應(yīng),則判定為健康檢查失敗。 說明
如果該值小于 HealthCheckInterval 的值,則該值無效,超時時間為 HealthCheckInterval 的值。
| 100 |
HealthCheckConnectPort | integer | 否 | 健康檢查使用的端口。取值范圍:1~65535。 不設(shè)置此參數(shù)時,表示使用 BackendServerPort(后端服務(wù)端口)。 | 8080 |
HealthCheckInterval | integer | 否 | 健康檢查的時間間隔。單位:秒。 取值范圍:1~50。 | 5 |
HealthCheckDomain | string | 否 | 用于健康檢查的域名。當 TCP 監(jiān)聽需要使用 HTTP 健康檢查時可配置此參數(shù),如不配置則按 TCP 健康檢查。
| 192.168.XX.XX |
HealthCheckURI | string | 否 | 用于健康檢查的 URI。長度為 1~80 個字符,支持字母、數(shù)字和短劃線(-)、正斜線(/)、半角句號(.)、百分號(%)、半角問號(?)、井號(#)和 and(&)這些字符。URI 不能只為正斜線(/),但必須以正斜線(/)開頭。 當 TCP 監(jiān)聽需要使用 HTTP 健康檢查時,可配置此參數(shù)。 如不配置,則使用 TCP 健康檢查。 | /test/index.html |
HealthCheckHttpCode | string | 否 | 健康檢查正常的 HTTP 狀態(tài)碼,多個狀態(tài)碼用半角逗號(,)分割。 取值:http_2xx、http_3xx、http_4xx或http_5xx。 | http_2xx |
HealthCheckType | string | 否 | 健康檢查類型。取值:tcp 或 http。 | tcp |
SynProxy | string | 否 | 是否開啟負載均衡的攻擊防護功能 SynProxy。取值:
建議一般情況下不要調(diào)整這個參數(shù),由負載均衡控制。 | enable |
VServerGroup | string | 否 | 是否使用虛擬服務(wù)器組。取值:
說明
VserverGroup 和 MasterSlaveServerGroup 只允許一個值為 on。
| on |
VServerGroupId | string | 否 | 虛擬服務(wù)器組 ID。 | rsp-cige6j5**** |
MasterSlaveServerGroupId | string | 否 | 主備服務(wù)器組 ID。 說明
虛擬服務(wù)器組 ID 和主備服務(wù)器組 ID 只能選擇一個。
| rsp-cige**** |
MasterSlaveServerGroup | string | 否 | 是否使用主備服務(wù)器組。取值:
VserverGroup 和 MasterSlaveServerGroup 只允許一個值為 on。 | on |
AclId | string | 否 | 監(jiān)聽綁定的訪問策略組 ID。 當 AclStatus 參數(shù)值為 on 時,該參數(shù)必選。 | 12333 |
AclType | string | 否 | 訪問控制類型。取值:
說明
當 AclStatus 參數(shù)的值為 on 時,該參數(shù)有效。
| white |
AclStatus | string | 否 | 是否開啟訪問控制功能。取值:
| off |
Description | string | 否 | 自定義監(jiān)聽名稱。 長度限制為 1~256 個字符,支持中文、字母、數(shù)字、短劃線(-)、正斜線(/)、半角句號(.)和下劃線(_)。 | tcp_80 |
ConnectionDrain | string | 否 | 是否開啟連接優(yōu)雅中斷。取值:
| off |
ConnectionDrainTimeout | integer | 否 | 設(shè)置連接優(yōu)雅中斷超時時間。當 ConnectionDrain 取值為 on 時,該選項必選。單位:秒。 取值范圍:10~900。 | 300 |
ProxyProtocolV2Enabled | boolean | 否 | 是否支持通過 Proxy Protocol 協(xié)議攜帶客戶端源地址到后端服務(wù)器。取值:
| false |
HealthCheckSwitch | string | 否 | 是否開啟健康檢查。取值:
| on |
返回參數(shù)
示例
正常返回示例
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. | 共享型負載均衡實例不支持指定的參數(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 | 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 | InvalidParameter.ZoneNotSupport | The zone does not support the parameter %s. | 當前可用區(qū)不支持指定參數(shù)。 |
400 | OperationFailed.ServerGroupInUse | The VServerGroup or MasterSlaveServerGroup can not be close for this listener. | 操作失敗,原因是當前監(jiān)聽不支持關(guān)閉服務(wù)器組。 |
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 | InvalidParam.PortRange | The specified PortRange is invalid. | 指定的PortRange無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | QuotaLimitExceeds.AclAttachedToListener | %s. | - |
400 | QuotaLimitExceeds.TotalAclEntry | %s. | - |
400 | AclListenerOverLimit | %s. | - |
400 | Duplicated.AclEntry | %s. | Acl條目重復。 |
400 | ResourceNotFound.VServerGroup | %s. | 指定的服務(wù)器組不存在。 |
400 | IllegalParam.FailoverStrategy | The parameter FailoverStrategy is illegal. | 指定的FailoverStrategy無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | IllegalParam.FailoverThreshold | The parameter FailoverThreshold is illegal. | 指定的FailoverThreshold無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | MasterSlaveServerConflict | The servers are conflict for MasterSlaveGroup. | 主備服務(wù)器組的后端服務(wù)器沖突。 |
400 | MissingParam.VServerGroupId | The parameter VServerGroupId is missing. | 參數(shù)VServerGroupId缺失。 |
400 | OperationDenied.HealthCheckClosedForMasterSlaveMode | The operation is denied because of HealthCheckClosedForMasterSlaveMode. | 操作被拒絕,原因是主備模式下要求必須開啟健康檢查。 |
400 | InvalidParam.HealthCheck | The param of HealthCheck is illegal. | 指定的HealthCheck無效。請檢查參數(shù)約束,并在修改后重試。 |
400 | OperationDenied.MasterSlaveGroupLogEnabled | The operation is denied because of MasterSlaveGroupLogEnabled. | 操作被拒絕,原因是主備服務(wù)器組日志已啟用。 |
400 | OperationDenied.NotSupportAcl | The operation is denied because The single Tunnel or any Tunnel loadbalancer does not support config AccessControlList. | 操作被拒絕,原因是Single Tunnel和Any Tunnel 類型負載均衡實例不支持配置Acl。 |
400 | OperationDenied.FullNatModeNotAllowed | The operation is not allowed because of FullNatModeNotAllowed. | 操作被拒絕,原因是不支持FullNat模式。 |
400 | OperationDenied.OnlyIpv4SlbSupport | The operation is not allowed because of OnlyIpv4SlbSupport. | 操作被拒絕,原因是只有IPV4實例支持開啟FULL NAT模式。 |
400 | SpecNotSupportParameter | The instance with share spec does not support FullNatEnabled parameter. | 共享型實例不支持FullNatEnabled參數(shù)。 |
400 | Abs.VServerGroupIdAndMasterSlaveServerGroupId.MissMatch | Virtual service group ID or master slave server group ID is missing. Please check the input parameters. | 虛擬服務(wù)組ID或者主備服務(wù)器組ID缺失,請檢查輸入?yún)?shù)。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-09-08 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |