All Products
Search
Document Center

ENS:SetLoadBalancerHTTPSListenerAttribute

Last Updated:Oct 26, 2026

Modifies the configurations of an HTTPS listener.

Operation description

  • API rate limit: 100 calls per second.

  • Rate limit per user: 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:SetLoadBalancerHTTPSListenerAttribute

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 frontend port of the listener whose attributes you want to modify. Valid values: 1 to 65535.

10002

Description

string

No

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

Note

It cannot start with http:// or https://.

Listener description

Scheduler

string

No

The scheduling algorithm. Valid values:

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

  • wlc: Requests are distributed based on the weights and actual loads (connections) of backend servers. If the weights are the same, backend servers with fewer connections receive more requests.

  • rr: Requests are evenly 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 the health check. Valid values:

  • on: enables the health check.

  • off: disables the health check.

on

HealthCheckDomain

string

No

The domain name used for health checks.

Note

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

www.example.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 that must occur before the health check status of a backend server changes from fail (unreachable) to success (reachable). 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 that must occur before the health check status of a backend server changes from success (reachable) to fail (unreachable). Valid values: 2 to 10.

Note

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

3

HealthCheckTimeout

integer

No

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

  • Default value: 5.

  • 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 is invalid and the timeout period is the value of HealthCheckInterval.

9

HealthCheckConnectPort

integer

No

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

Note

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

7001

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 codes that indicate 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. Valid values: 1 to 60. Unit: seconds.

Note

If there is no access request within the timeout period, load balancing temporarily breaks the current connection until a new connection is established when the next request arrives.

15

RequestTimeout

integer

No

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

Note

If a backend server does not send a response within the timeout period, load balancing stops waiting and returns an HTTP 504 error code to the client.

60

ServerCertificateId

string

No

The ID of the server certificate.

6027667

HealthCheckMethod

string

No

The HTTP method used for health checks. Valid values:

  • head (default): requests only the header of the page.

  • get: requests the specified page information and returns the entity body.

Note

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

Valid values:

  • head :

    HEAD method.

  • get :

    GET method.

get

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The ID of the request.

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 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 ServerCertificateNotFound The input parameter serverCertificateId 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 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.