All Products
Search

This Product

    ENS:SetLoadBalancerTCPListenerAttribute

    Document Center

    ENS:SetLoadBalancerTCPListenerAttribute

    Last Updated:May 07, 2026

    Call SetLoadBalancerTCPListenerAttribute to modify the attributes of a TCP listener.

    Operation description

    • API call rate: 100 calls per second.

    • Single-user call rate: 10 calls per second.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ens:SetLoadBalancerTCPListenerAttribute

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    LoadBalancerId

    string

    Yes

    The ID of the load balancer instance.

    lb-5snthcyu1x10g7tywj7iu****
    ListenerPort

    integer

    Yes

    The listener port to modify. Valid values: 1 to 65535.

    80
    Description

    string

    No

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

    Note

    The description cannot start with http:// or https://.

    example
    Scheduler

    string

    No

    The scheduling algorithm. Valid values:

    • wrr (Weighted Round Robin): Backend servers with higher weights receive more requests.

    • wlc (Weighted Least Connections): In addition to the weight of each backend server, this algorithm considers the number of connections to each server. If multiple servers have the same weight, the server with the fewest connections receives the next request.

    • rr (Round Robin): Requests are distributed to backend servers in sequence.

    • sch (Source-based Consistent Hashing): Requests from the same source IP address are routed to the same backend server.

    • tch (Four-tuple-based Consistent Hashing): Requests from the same flow, identified by source IP, destination IP, source port, and destination port, are routed to the same backend server.

    wrr
    PersistenceTimeout

    integer

    No

    The session persistence timeout.

    • Default value: 0, which disables session persistence.

    • Valid values: 0 to 3600.

    • Unit: seconds.

    0
    EstablishedTimeout

    integer

    No

    The connection timeout, in seconds. Valid values: 10 to 900.

    500
    HealthyThreshold

    integer

    No

    The number of consecutive successful health checks required to mark an unhealthy backend server as healthy. Valid values: 2 to 10.

    4
    UnhealthyThreshold

    integer

    No

    The number of consecutive failed health checks required to mark a healthy backend server as unhealthy. Valid values: 2 to 10.

    4
    HealthCheckConnectTimeout

    integer

    No

    The response timeout for a health check. If a backend ENS instance does not respond within this period, the health check fails.

    • Default value: 5.

    • Valid values: 1 to 300.

    • Unit: seconds.

    Note

    If the value of HealthCheckConnectTimeout is less than that of HealthCheckInterval, the HealthCheckConnectTimeout setting is ignored and the HealthCheckInterval value is used as the timeout.

    100
    HealthCheckConnectPort

    integer

    No

    The port used for health checks. Valid values: 1 to 65535. If omitted, the backend service port (BackendServerPort) is used.

    8000
    HealthCheckInterval

    integer

    No

    The interval between health checks, in seconds. Valid values: 1 to 50.

    5
    HealthCheckDomain

    string

    No

    The domain name used for health checks.

    www.aliyundoc.com
    HealthCheckURI

    string

    No

    The URI for health checks. The URI must be 1 to 80 characters long.

    Note

    The URI must start with / and must not consist solely of /.

    /aliyundoc/index.html
    HealthCheckHttpCode

    string

    No

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

    • http_2xx (default).

    • http_3xx.

    • http_4xx.

    • http_5xx.

    http_2xx
    HealthCheckType

    string

    No

    The health check type. Valid values:

    • tcp (default).

    • http.

    tcp
    EipTransmit

    string

    No

    Whether to enable EIP passthrough. Valid values:

    • on: Enables EIP passthrough.

    • off (default): Disables EIP passthrough.

    on

    Response elements

    Element

    Type

    Description

    Example

    object

    The response schema.

    RequestId

    string

    The request ID.

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

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ens.interface.error An error occurred while call the API.
    400 Invalid%s The specified parameter %s is invalid.
    400 Missing%s You must specify the parameter %s.
    400 LoadBalancerNotFound The input parameter loadBalancerId that is not found.
    400 IncorrectInstanceStatus The current status of the resource does not support this operation. The current operation is not supported. The disk is being reset.
    400 ListenerNotFound The input parameter listener that is not found.
    400 IncorrectListenerStatus The current status of the resource does not support this operation. The listener status is incorrect.
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.