You can call the SetLoadBalancerUDPListenerAttribute API to modify the configurations of a UDP listener.

Debug

Click here to perform a debug operation in OpenAPI Explorer and automatically generate an SDK code example.

Request parameters

Name Type Required? Example value Description
Action String Yes SetLoadBalancerUDPListenerAttribute

The action to perform. Valid value: SetLoadBalancerUDPListenerAttribute

ListenerPort Integer Yes 80

The frontend port used by the SLB instance.

Valid values: 1–65535

LoadBalancerId String Yes lb-bp1rtfnodmywb43ecu4sf-cn-east-hangzhou-01

The ID of the SLB instance

RegionId String Yes cn-hangzhou

The ID of the region to which the SLB instance belongs

AclId String No off

The ID of the access control list bound to the listener.

If the value of AclStatus is on, this parameter is required.

AclStatus String No off

Whether to enable access control.

Valid values: on | off

AclType String No white

The access control type:

  • white: Indicates a whitelist. Only requests from IP addresses or CIDR blocks in the selected access control lists are forwarded. It applies to scenarios where an application only allows access from specific IP addresses.
Enabling a whitelist poses some risks to your services.

After a whitelist is enabled, only the IP addresses in the list can access the listener.

If you enable a whitelist without adding any IP addresses in the list, all requests are forwarded.

  • black: Indicates a blacklist. Requests from IP addresses or CIDR blocks in the selected access control lists are not forwarded (that is, they are blocked). It applies to scenarios where an application only denies access from specific IP addresses.
If you enable a blacklist without adding any IP addresses in the list, all requests are forwarded.

If the value of AclStatus is on, this parameter is required.

Bandwidth Integer No -1

The peak bandwidth of the listener. Valid values:

  • -1: The peak bandwidth is not limited.
  • 1–5000: The peak bandwidth of the listener. The sum of the peak bandwidth values of all listeners cannot surpass the peak bandwidth of the instance.
Description String No test

A description of the listener

HealthCheckConnectPort Integer No 80

The port used for health checks.

Valid values: 1–65535

HealthCheckConnectTimeout Integer No 100

The amount of time to wait for the response from the health check. If the backend ECS instance does not send a correct response within the specified time, the health check fails.

Valid values: 1–300 (seconds).

Note If the value of HealthCheckInterval is greater than the value of HealthCheckConnectTimeout, the HealthCheckConnectTimeout parameter is invalid, and the timeout is set to the value of HealthCheckInterval.
HealthCheckInterval Integer No 5

The time interval between two consecutive health checks.

Valid values: 1–50 (seconds)

HealthyThreshold Integer No 4

The number of consecutive successes of health checks before a backend server is declared as healthy (from failure to success).

Valid values: 2–10

MasterSlaveServerGroup String No on

Whether to use an active/standby server group. Valid values: on | off

The value of VserverGroup and the value of MasterSlaveServerGroup cannot be on at the same time.

MasterSlaveServerGroupId String No rsp-0bfucwuotx

The ID of the active/standby server group.

Note You can only choose either VServerGroupId or MasterSlaveServerGroupId.
Scheduler String No wrr

The algorithm used to distribute traffic. Valid values:

  • wrr: A backend server with a higher weight is more likely to be polled.
  • wlc: A server with a higher weight will receive more requests.
When the weight value is the same, the backend server with a smaller number of connections is more likely to be polled.
  • rr: Requests are evenly and sequentially distributed to the backend servers.
  • sch: A consistent hash based on the source IP address. Requests with the same source IP addresses are scheduled to the same backend server.
  • tch: A consistent hash based on the following four parameters: source IP + destination IP + source port + destination port. The same streams are scheduled to the same backend server.
  • qch: A consistent hash based on the QUIC Connection ID. The same QUIC Connection IDs are scheduled to the same backend servers.
Note Only guaranteed-performance instances support sch, tch, and qch.
UnhealthyThreshold Integer No 4

The number of consecutive failures of health checks before a backend server is declared as unhealthy (from success to failure).

Valid values: 2–10

VServerGroup String No on

Whether to use a VServer group.

Valid values: on | off

Note The value of VServerGroup and the value of MasterSlaveServerGroup cannot be on at the same time.
VServerGroupId String No rsp-cige6j5e7p

The ID of the VServer group

healthCheckExp String No ok

The response string for the health check of the UDP listener. It must be 1 to 500 characters in length and can only contain letters and numbers.

healthCheckReq String No hello

The response string for the health check of the UDP listener. It must be 1 to 500 characters in length and can only contain letters and numbers.

Response parameters

Name Type Example value Description
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

The ID of the request

Examples

Request example


http(s)://[Endpoint]/? Action=SetLoadBalancerUDPListenerAttribute
&ListenerPort=80
&LoadBalancerId=lb-bp1rtfnodmywb43ecu4sf-cn-east-hangzhou-01
&<CommonParameters>

Normal response examples

XML format

<SetLoadBalancerUDPListenerAttributeResponse>
  <RequestId>A0F0643E-D653-4F6F-A67F-205B2A92BE18</RequestId>
</SetLoadBalancerUDPListenerAttributeResponse>

JSON format

{
	"RequestId":"A0F0643E-D653-4F6F-A67F-205B2A92BE18"
}

Error response example

JSON format

{
	"Message":"The specified parameter is not valid.",
	"RequestId":"0669D684-69D8-408E-A4FA-B9011E0F4E66",
	"HostId":"slb-pop.aliyuncs.com",
	"Code":"InvalidParameter"
}

Error codes

Click here to view the error codes.