All Products
Search
Document Center

ENS:SetLoadBalancerTCPListenerAttribute

Last Updated:Mar 12, 2024

Modifies the configurations of a TCP listener.

Operation description

  • You can call this operation up to 100 times per second per account.
  • You can call this operation up to 10 times per second per user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LoadBalancerIdstringYes

The ID of the Edge Load Balancer (ELB) instance.

lb-5snthcyu1x10g7tywj7iu****
ListenerPortintegerYes

The frontend port that is used by the ELB instance. Valid values: 1 to 65535.

80
DescriptionstringNo

The description of the listener. The description must be 1 to 80 characters in length.

Note The value cannot start with http:// or https://.
example
SchedulerstringNo

The routing algorithm. Valid values:

  • wrr: Backend servers with higher weights receive more requests than those with lower weights.
  • wlc: Requests are distributed based on the weight and load of each backend server. The load refers to the number of connections to a backend server. If two backend servers have the same weight, the backend server that has fewer connections receives more requests.
  • rr: Requests are distributed to backend servers in sequence.
  • sch: consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server.
  • qch: consistent hashing that is based on QUIC connection IDs. Requests that contain the same QUIC connection ID are distributed to the same backend server.
  • iqch: consistent hashing that is based on specific three bytes of the iQUIC CIDs. Requests whose second to fourth bytes are the same are distributed to the same backend server.
wrr
PersistenceTimeoutintegerNo

The timeout period of session persistence.

  • Default value: 0. If the default value is used, the system disables session persistence.
  • Valid values: 0 to 3600.
  • Unit: seconds.
0
EstablishedTimeoutintegerNo

The timeout period of a connection. Valid values: 10 to 900. Unit: seconds.

500
HealthyThresholdintegerNo

The number of consecutive successful health checks that must occur before an unhealthy and inaccessible backend server is declared healthy and accessible. Valid values: 2 to 10.

4
UnhealthyThresholdintegerNo

The number of consecutive failed health checks that must occur before a healthy and accessible backend server is declared unhealthy and inaccessible. Valid values: 2 to 10.

4
HealthCheckConnectTimeoutintegerNo

The timeout period of a health check response. If a backend server does not respond within the specified timeout period, the server fails to pass the health check.

  • Default value: 5.
  • Valid values: 1 to 300.
  • Unit: seconds.
Note If the value that you specified for HealthCheckConnectTimeout is smaller than the value of HealthCheckInterval, HealthCheckConnectTimeout becomes invalid and the timeout period that you specified for HealthCheckInterval is used.
100
HealthCheckConnectPortintegerNo

The port that is used for health checks. Valid values: 1 to 65535. If you leave this parameter empty, the port specified by BackendServerPort is used for health checks.

8000
HealthCheckIntervalintegerNo

The interval at which health checks are performed. Valid values: 1 to 50. Unit: seconds.

5
HealthCheckDomainstringNo

The domain name that you want to use for health checks.

www.aliyundoc.com
HealthCheckURIstringNo

The Uniform Resource Identifier (URI) that you want to use for health checks. The URI must be 1 to 80 characters in length.

Note The URL must start with / and contain characters other than /.
/aliyundoc/index.html
HealthCheckHttpCodestringNo

The HTTP status code for a successful health check. Valid values:

  • http_2xx (default)
  • http_3xx.
  • http_4xx
  • http_5xx
http_2xx
HealthCheckTypestringNo

The type of health checks. Valid values:

  • tcp (default)
  • http
tcp
EipTransmitstringNo

Specifies whether to enable Elastic IP address (EIP) pass-through. Valid values:

  • on
  • off (default)
on

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

06F00FBB-3D9E-4CCE-9D43-1A6946A75456

Examples

Sample success responses

JSONformat

{
  "RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}

Error codes

HTTP status codeError codeError messageDescription
400ens.interface.errorAn error occurred while call the API.-
400Invalid%sThe specified parameter %s is invalid.-
400Missing%sYou must specify the parameter %s.-
400LoadBalancerNotFoundThe input parameter loadBalancerId that is not found.-
400IncorrectInstanceStatusThe current status of the resource does not support this operation.The current operation is not supported. The disk is being reset.
400ListenerNotFoundThe input parameter listener that is not found.-
400IncorrectListenerStatusThe current status of the resource does not support this operation.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history