All Products
Search

This Product

    ENS:SetLoadBalancerHTTPListenerAttribute

    Document Center

    ENS:SetLoadBalancerHTTPListenerAttribute

    Last Updated:Aug 14, 2026

    Modifies the configuration of an HTTP listener.

    Operation description

    • API call frequency: 100 calls per second.

    • Per-user call frequency: 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:SetLoadBalancerHTTPListenerAttribute

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    LoadBalancerId

    string

    Yes

    The ID of the load balancing instance.

    lb-5snthcyu1x10g7tywj7iu****
    ListenerPort

    integer

    Yes

    The listener port whose attributes you want to modify. Valid values: 1 to 65535.

    8080
    Description

    string

    No

    The listener name. The name must be 1 to 80 characters in length.

    Note

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

    Listener description
    Scheduler

    string

    No

    The scheduling algorithm. Valid values:

    • wrr: Backend servers with higher weights are polled more frequently.

    • wlc: Requests are distributed based on the weight and actual load (number of connections) of each backend server. When the weights are the same, backend servers with fewer connections are polled more frequently.

    • rr: Requests are distributed to backend servers in sequence.

    • sch: Consistent hashing based on source IP addresses. Requests from the same source IP address are distributed to the same backend server.

    • qch: Consistent hashing based on QUIC Connection IDs. Requests with the same QUIC Connection ID are distributed to the same backend server.

    • iqch: Consistent hashing based on specific three bytes of the iQUIC CID. Requests with the same 2nd to 4th bytes are distributed to the same backend server.

    Valid values:

    • rr :

      round robin.

    • wrr :

      weighted round robin.

    • wlc :

      weighted least connections.

    wrr
    HealthCheck

    string

    No

    Specifies whether to enable health checks. Valid values:

    • on: enabled.

    • off: disabled.

    on
    HealthCheckDomain

    string

    No

    The domain name used for health checks.

    Note

    This parameter takes effect only when HealthCheck is set to on.

    www.aliyundoc.com
    HealthCheckURI

    string

    No

    The URI used for health checks. The URI must be 1 to 80 characters in length.

    Note

    • The URI cannot be only / but must start with /.

    • This parameter takes effect only when HealthCheck is set to on.

    /checkpreload.htm
    HealthyThreshold

    integer

    No

    The number of consecutive successful health checks required before a backend server is declared healthy (changing the status from fail to success). Valid values: 2 to 10.

    Note

    This parameter takes effect only when HealthCheck is set to on.

    3
    UnhealthyThreshold

    integer

    No

    The number of consecutive failed health checks required before a backend server is declared unhealthy (changing the status from success to fail). Valid values: 2 to 10.

    Note

    This parameter takes effect only when HealthCheck is set to on.

    3
    HealthCheckTimeout

    integer

    No

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

    • Default value: 5 seconds.

    • Valid values: 1 to 300.

    • Unit: seconds.

    Note

    • This parameter takes effect only when HealthCheck is set to on.

    • If the value of HealthCheckTimeout is less than the value of HealthCheckInterval, HealthCheckTimeout becomes ineffective and the timeout period equals the value of HealthCheckInterval.

    5
    HealthCheckConnectPort

    integer

    No

    The port used for health checks. Valid values: 1 to 65535. If this parameter is not configured in Settings, the backend service port (BackendServerPort) is used.

    Note

    This parameter takes effect only when HealthCheck is set to on.

    65500
    HealthCheckInterval

    integer

    No

    The interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds.

    Note

    This parameter takes effect only when HealthCheck is set to on.

    2
    HealthCheckHttpCode

    string

    No

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

    • http_2xx (default).

    • http_3xx.

    • http_4xx.

    • http_5xx.

    Note

    This parameter takes effect only when HealthCheck is set to on.

    http_2xx
    IdleTimeout

    integer

    No

    The idle connection timeout period. Default value: 15 seconds. Valid values: 1 to 60. Unit: seconds.

    Note

    If no access request is received within the timeout period, the load balancing instance temporarily breaks the current connection and re-establishes a new connection when the next request arrives.

    15
    RequestTimeout

    integer

    No

    The request timeout period. Default value: 60 seconds. Valid values: 1 to 180. Unit: seconds.

    Note

    If no response is received from the backend server within the timeout period, the load balancing instance stops waiting and returns an HTTP 504 error code to the client.

    60
    HealthCheckMethod

    string

    No

    The health check method for the HTTP listener. Valid values:

    • head.

    • get.

    Note

    This parameter takes effect only when HealthCheck is set to on.

    Valid values:

    • head :

      HEAD method.

    • get :

      GET method.

    head
    XForwardedFor

    string

    No

    Specifies whether to use the X-Forwarded-For header to retrieve the originating IP address of the client. Valid values:

    • on (default): enabled.

    • off: disabled.

    Valid values:

    • off :

      disabled.

    • on :

      enabled.

    on

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Examples

    Success response

    JSON format

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

    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.