Modifies the configurations of a UDP listener.

Prerequisites

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String No cn-hangzhou

The ID of the region where the CLB instance is deployed.

You can call the DescribeRegions operation to query the most recent region list.

Action String Yes SetLoadBalancerUDPListenerAttribute

The operation that you want to perform. Set the value to

SetLoadBalancerUDPListenerAttribute.

LoadBalancerId String Yes lb-bp1rtfnodmywb43ecu4sf-c****

The ID of the CLB instance.

ListenerPort Integer Yes 80

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

Bandwidth Integer No -1

The maximum bandwidth of the listener. Unit: Mbit/s. Valid values:

  • -1: For a pay-by-data-transfer Internet-facing CLB instance, you can set this parameter to -1. This way, the bandwidth of the listener is unlimited.
  • 1 to 5120: For a pay-by-bandwidth Internet-facing CLB instance, you can specify the maximum bandwidth of each listener. The sum of bandwidth limits that you set for all listeners cannot exceed the maximum bandwidth of the CLB instance.
Scheduler String No wrr

The routing algorithm. Valid values:

  • wrr: Backend servers with higher weights receive more requests than those with lower weights.

    If two backend servers have the same weight, the backend server that has fewer connections is expected to receive more requests.

  • rr: Requests are distributed to backend servers in sequence.
  • sch: specifies consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server.
  • tch: specifies consistent hashing that is based on the following parameters: source IP address, destination IP address, source port, and destination port. Requests that contain the same preceding information are distributed to the same backend server.
  • qch: specifies consistent hashing that is based on QUIC connection IDs. Requests that contain the same QUIC connection ID are distributed to the same backend server.
Note
  • Only high-performance CLB instances support sch, tch, and qch.
  • You cannot switch the algorithm used by a CLB instance from wrr or rr to consistent hashing or from consistent hashing to weighted round robin or round robin.
HealthyThreshold Integer No 4

The number of times that an unhealthy backend server must consecutively pass health checks before it can be declared healthy (from fail to success).

Valid values: 1 to 10.

UnhealthyThreshold Integer No 4

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status is changed from success to fail.

Valid values: 1 to 10.

HealthCheckConnectTimeout Integer No 100

The timeout period of a health check. If a backend server does not respond within the specified timeout period, the server fails the health check. Unit: seconds.

Valid values: 1 to 300.

Note If the value of the HealthCheckConnectTimeout parameter is smaller than that of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckConnectTimeout parameter is ignored and the period of time specified by the HealthCheckInterval parameter is used as the timeout period.
HealthCheckConnectPort Integer No 80

The port that is used for health checks.

Valid values: 1 to 65535.

HealthCheckInterval Integer No 5

The interval at which health checks are performed. Unit: seconds.

Valid values: 1 to 50.

healthCheckReq String No hello

The request string for UDP listener health checks. The string must be 1 to 64 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 64 characters in length and can contain only letters and digits.

VServerGroup String No on

Specifies whether to use a vServer group. Valid values:

  • on: yes
  • off: no
Note You cannot set both VserverGroup and MasterSlaveServerGroup to on.
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 both VServerGroupId and MasterSlaveServerGroupId.
MasterSlaveServerGroup String No on

Specifies whether to use a primary/secondary server group. Valid values:

  • on: yes
  • off: no
Note You cannot set VserverGroup and MasterSlaveServerGroup both to on.
AclId String No off

The ID of the network access control list (ACL) that is associated with a listener.

Note If AclStatus is set to on, this parameter is required.
AclType String No white

The type of network ACL. Valid values:

  • white: a whitelist. Only requests from the IP addresses or CIDR blocks in the network ACL are forwarded. Whitelists apply to scenarios where you want to allow only specific IP addresses to access an application. Your service may be adversely affected if the whitelist is not properly configured. After a whitelist is configured, only requests from IP addresses that are added to the whitelist are forwarded by the listener.

    If a whitelist is configured but no IP address is added to the whitelist, the listener forwards all requests.

  • black: a blacklist. All requests from the IP addresses or CIDR blocks in the network ACL are denied. Blacklists apply to scenarios where you want to block access from specified IP addresses to an application.

    If a blacklist is configured but no IP address is added to the blacklist, the listener forwards all requests.

Note If AclStatus is set to on, this parameter is required.
AclStatus String No off

Specifies whether to enable access control for a listener. Valid values:

  • on: yes
  • off: no
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]/?RegionId=cn-hangzhou
&Action=SetLoadBalancerUDPListenerAttribute
&LoadBalancerId=lb-bp1rtfnodmywb43ecu4sf-c****
&ListenerPort=80
&Bandwidth=-1
&Scheduler=wrr
&HealthyThreshold=4
&UnhealthyThreshold=4
&HealthCheckConnectTimeout=100
&HealthCheckConnectPort=80
&HealthCheckInterval=5
&healthCheckReq=hello
&healthCheckExp=ok
&VServerGroup=on
&VServerGroupId=rsp-cige6****
&MasterSlaveServerGroupId=rsp-0bfuc****
&MasterSlaveServerGroup=on
&AclId=off
&AclType=white
&AclStatus=off
&Description=test
&PortRange=[{}]
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<SetLoadBalancerUDPListenerAttributeResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
</SetLoadBalancerUDPListenerAttributeResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameterValue.SpecNotSupport The loadBalancer of shared spec does not support the parameter value, %s. The error message returned because shared-resource CLB instances do not support the specified parameters.
400 OperationNotSupport.Acl The cloud box instance does not support acl. The error message returned because you cannot enable access control for an instance connected to a cloud box.
400 InvalidParameterValue.RegionNotSupport The region does not support the parameter value, %s. The error message returned because the specified parameter value is not supported in the current region.
400 IpVersionConflict The ip version of this LoadBalancer and the Acl is conflict. The error message returned because the specified IP version is not supported by the network ACL.
400 InvalidParameterValue.ZoneNotSupport The zone does not support the parameter value, %s. The error message returned because the specified parameter value is not supported in the current zone.
400 OperationFailed.ServerGroupInUse The VServerGroup or MasterSlaveServerGroup can not be close for this listener. The error message returned because you cannot disable the server group for the listener.
400 InvalidParam.VServerGroupId The specified VServerGroupId is invalid. The error message returned because VServerGroupId is set to an invalid value. Specify a valid value and try again.
400 MissingParam.HealthCheckConnectPort The parameter HealthCheckConnectPort is required. The error message returned because HealthCheckConnectPort is not set.
400 InvalidParam.ListenerPort The specified ListenerPort is invalid. The error message returned because ListenerPort is set to an invalid value. Specify a valid value and try again.
400 InvalidParam.StartPort The specified StartPort is invalid. The error message returned because StartPort is set to an invalid value. Specify a valid value and try again.
400 InvalidParamSize.PortRange The size of param PortRange is invalid. The error message returned because PortRange is set to an invalid value. Specify a valid value and try again.
400 InvalidParam.EndPort The specified EndPort is invalid. The error message returned because EndPort is set to an invalid value. Specify a valid value and try again.
400 InvalidParam.PortRange The specified PortRange is invalid. The error message returned because PortRange is set to an invalid value. Specify a valid value and try again.
400 QuotaLimitExceeds.AclAttachedToListener %s. The error message returned because the number of listeners associated with the network ACL has reached the upper limit.
400 QuotaLimitExceeds.TotalAclEntry %s. The error message returned because the number of network ACL rules has reached the upper limit.
400 Duplicated.AclEntry %s. The error message returned because the specified ACL rule already exists.
400 InvalidParamLength.HealthCheckReq The length of the parameter HealthCheckReq is invalid. The error message returned because the HealthCheckReq parameter is set to an invalid value. Specify a valid value and try again.
400 InvalidParamLength.HealthCheckExp The length of the parameter HealthCheckExp is invalid. The error message returned because the HealthCheckExp parameter is set to an invalid value. Specify a valid value and try again.
400 InvalidParam.HealthCheckReq The param HealthCheckReq is invalid. The error message returned because the HealthCheckReq parameter is set to an invalid value. Specify a valid value and try again.
400 InvalidParam.HealthCheckExp The param HealthCheckExp is invalid. The error message returned because the HealthCheckExp parameter is set to an invalid value. Specify a valid value and try again.
400 ResourceNotFound.VServerGroup %s. The error message returned because the specified server group does not exist.
400 IllegalParam.FailoverThreshold The parameter FailoverThreshold is illegal. The error message returned because FailoverThreshold is set to an invalid value. Specify a valid value and try again.
400 IllegalParam.FailoverStrategy The parameter FailoverStrategy is illegal. The error message returned because FailoverStrategy is set to an invalid value. Specify a valid value and try again.
400 InvalidParameter.ZoneNotSupport The zone does not support the parameter %s. The error message returned because the specified parameter is not supported in the current zone.
400 MasterSlaveServerConflict The servers are conflict for MasterSlaveGroup. The error message returned because the backend servers in the primary/secondary server group must not be the same.
400 MissingParam.VServerGroupId The parameter VServerGroupId is missing. The error message returned because VServerGroupId is not set.
400 VipNotSupportQuicVersion The listener does not support the parameter of QuicVersion. The error message returned because the listener does not support the QuicVersion parameter.
400 IllegalParam.HealthCheckType The param of HealthCheckType is illegal. The error message returned because HealthCheckType is set to an invalid value. Specify a valid value and try again.
400 IllegalParam.HealthCheckMethod The param of HealthCheckMethod is illegal. The error message returned because HealthCheckMethod is set to an invalid value. Specify a valid value and try again.
400 IllegalParam.HealthCheck The param of HealthCheck is illegal. The error message returned because HealthCheck is set to an invalid value. Specify a valid value and try again.
400 OperationDenied.MasterSlaveGroupLogEnabled The operation is denied because of MasterSlaveGroupLogEnabled. The error message returned because you cannot perform the operation when the log feature is enabled for the primary/secondary server group.
400 OperationDenied.OnlyIpv4SlbSupport The operation is not allowed because of OnlyIpv4SlbSupport. The error message returned because only IPv4 instances support the full NAT mode.
400 OperationDenied.FullNatModeNotAllowed The operation is not allowed because of FullNatModeNotAllowed. The error message returned because the full NAT mode is not supported.
400 SpecNotSupportParameter The instance with share spec does not support FullNatEnabled parameter. The error message returned because shared-resource CLB instances do not support the FullNatEnabled parameter.

For a list of error codes, visit the API Error Center.