Modifies the configurations of a UDP listener.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | SetLoadBalancerUDPListenerAttribute |
The operation that you want to perform. Set the value to SetLoadBalancerUDPListenerAttribute. |
ListenerPort | Integer | Yes | 80 |
The frontend port that is used by the SLB instance. Valid values: 1 to 65535. |
LoadBalancerId | String | Yes | lb-bp1rtfnodmywb43ecu4sf-c**** |
The ID of the SLB instance. |
RegionId | String | Yes | cn-hangzhou |
The ID of the region where the SLB instance is created. |
Bandwidth | Integer | No | -1 |
The maximum bandwidth of the listener. Unit: Mbit/s. Valid values: 1 to 5120 and -1.
|
Scheduler | String | No | wrr |
The scheduling algorithm. Valid values:
Note Only guaranteed-performance SLB instances support sch, tch, and qch.
|
HealthyThreshold | Integer | No | 4 |
The number of consecutive successful health checks that must occur before a backend server is declared healthy (from fail to success). Valid values: 2 to 10. |
UnhealthyThreshold | Integer | No | 4 |
The number of consecutive failed health checks that must occur before a backend server is declared unhealthy. (from success to fail). Valid values: 2 to 10. |
HealthCheckConnectTimeout | Integer | No | 100 |
The time period to wait for a health check response. If a backend server does not respond within the specified time period, the health check fails. Valid values: 1 to 300 . Unit: seconds. Note If the value of the HealthCheckConnectTimeout parameter is smaller than that of the HealthCheckInterval parameter, the value of the HealthCheckConnectTimeout parameter is ignored and the value of the HealthCheckInterval parameter is regarded as the waiting period.
|
HealthCheckConnectPort | Integer | No | 80 |
The port that is used for health checks. Valid values: 1 to 65535. |
HealthCheckInterval | Integer | No | 5 |
The interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. |
healthCheckReq | String | No | hello |
The request string for UDP listener health checks. The string must be 1 to 500 characters in length and can contain only letters and digits. |
healthCheckExp | String | No | ok |
The response string for UDP listener health checks. The string must be 1 to 500 characters in length and can contain only letters and digits. |
VServerGroup | String | No | on |
Specifies whether to use a VServer group. Valid values: on and off. Note The value of VserverGroup and the value of MasterSlaveServerGroup cannot be set to on at the same time.
|
VServerGroupId | String | No | rsp-cige6****** |
The ID of the VServer group. |
MasterSlaveServerGroupId | String | No | rsp-0bfuc***** |
The ID of the primary/secondary server group. Note You cannot specify the VServer group ID and primary/secondary server group ID at the
same time.
|
MasterSlaveServerGroup | String | No | on |
Specifies whether to use a primary/secondary server group. Valid values: on and off. The value of VserverGroup and the value of MasterSlaveServerGroup cannot be set to on at the same time. |
AclId | String | No | off |
The ID of the access control list (ACL) to which the listener is bound. This parameter is required when the AclStatus parameter is set to on. |
AclType | String | No | white |
The type of ACL. Valid values: white and black.
Note This parameter takes effect when the AclStatus parameter is set to on.
|
AclStatus | String | No | off |
Specifies whether to enable the access control feature. Valid values: on and off. |
Description | String | No | test |
The description of the listener. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=SetLoadBalancerUDPListenerAttribute
&ListenerPort=80
&LoadBalancerId=lb-bp1rtfnodmywb43ecu4sf-c****
&<Common request parameters>
Sample success responses
XML
format
<SetLoadBalancerUDPListenerAttributeResponse>
<RequestId>A0F0643E-D653-4F6F-A67F-205B2A92BE18</RequestId>
</SetLoadBalancerUDPListenerAttributeResponse>
JSON
format
{
"RequestId": "A0F0643E-D653-4F6F-A67F-205B2A92BE18"
}
Error codes
For a list of error codes, visit the API Error Center.