You can call this operation to modify the configurations of an HTTP listener.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SetLoadBalancerHTTPListenerAttribute

The operation that you want to perform.

Set the value to SetLoadBalancerHTTPListenerAttribute.

ListenerPort Integer Yes 80

The listener port of the SLB instance.

Valid values: 1 to 65535.

LoadBalancerId String Yes lb-bp1qjwo61pqz3ah*****

The ID of the SLB instance.

RegionId String Yes cn-hangzhou

The region where the SLB instance is deployed.

You can retrieve the region ID from the Regions and zones list or by calling the DescribeRegionsoperation.

Bandwidth Integer No -1

The peak bandwidth of the listener. Unit: Mbit/s. Valid values: -1 or 1 to 5120.

  • -1: For a pay-by-traffic Internet-facing SLB instance, set the peak bandwidth to-1. This indicates that the peak bandwidth is not limited.
XForwardedFor String No on

Specifies whether to use the X-Forwarded-For header to obtain the real IP address of the client.

Set the value to on.

Scheduler String No wrr

The scheduling algorithm. Valid values:

  • wrr: A backend server with a higher weight is expected to receive more requests.
  • rr: Requests are distributed to each backend server on a rotation.
StickySession String No on

Specifies whether to enable session persistence.

Valid values: on and off.

StickySessionType String No insert

The method used to handle a cookie. Valid values:

  • insert: Insets a cookie.

    SLB inserts a cookie (SERVERID) to the first HTTP or HTTPS response packet sent to a client. The next request from the client will contain the cookie, and the listener will deliver the request to the backend server with the specified SERVERID.

  • server: Rewrites a cookie.

    When SLB detects a user-defined cookie, it overwrites the original cookie with the user-defined cookie. The next request from the client will contain the user-defined cookie, and the listener will distribute the request to the recorded backend server.
    Note If you set the StickySession parameter to on, you must specify this parameter.
CookieTimeout Integer No 500

The timeout period of a cookie. Unit: seconds.

Valid values: 1 to 86400.

Note If you set the StickySession parameter to on and the StickySessionType parameter to insert, you must also specify the CookTimeout parameter.
Cookie String No B490B5EBF6F3CD402E515D22BCDA1598

The cookie configured on the backend server.

The cookie must be 1 to 200 characters in length and can contain ASCII letters and digits. It cannot contain commas (,), semicolons (;), or spaces. It cannot start with a dollar sign ($).

Note If you set the StickySession parameter to on and the StickySessionType parameter to server, you must also specify the Cookie parameter.
HealthCheck String No on

Specifies whether to enable health check.

Valid values: on and off.

HealthCheckDomain String No 172.16.**. **

The domain name used for health check. Valid values:

  • $_ip: The private IP address of the backend server. If the $_ip parameter is specified or the HealthCheckDomain parameter is not specified, SLB uses the private IP addresses of backend servers as the domain names for health check.
  • domain: The domain name must be 1 to 80 characters in length and can contain only letters, digits, periods (.) and hyphens (-).
Note This parameter only takes effect when the HealthCheck parameter is set to on.
HealthCheckURI String No /test/index.html

The URI used for health checks.

The value must be 1 to 80 characters in length and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL must start with a forward slash (/).

Note This parameter only takes effect when the HealthCheck parameter is set to on.
HealthyThreshold Integer No 4

The number of consecutive health check successes required before a backend server is declared healthy (from fail to success).

Valid values: 2 to 10.

Note This parameter only takes effect when the HealthCheck parameter is set to on.
UnhealthyThreshold Integer No 4

The number of consecutive health check failures required before a backend server is declared unhealthy (from success to fail).

Valid values: 2 to 10.

Note This parameter only takes effect when the HealthCheck parameter is set to on.
HealthCheckTimeout Integer No 3

The response timeout period. If the backend ECS instance does not send an expected response within the specified period of time, the health check fails. Unit: seconds. This parameter only takes effect when the HealthCheck parameter is set to on.

Valid values: 1 to 300 .

Note If the value of the HealthCheckTimeout parameter is smaller than that of the HealthCheckInterval parameter, the value of the HealthCheckTimeout parameter is ignored and the value of the HealthCheckInterval parameter is regarded as the timeout period.
HealthCheckInterval Integer No 5

The time interval between two consecutive health checks. Unit: seconds.

Valid values: 1 to 50 .

Note This parameter only takes effect when the HealthCheck parameter is set to on.
HealthCheckConnectPort Integer No 8080

The port used for health checks.

Valid values: 1 to 65535.

Note This parameter only takes effect when the HealthCheck parameter is set to on.
HealthCheckHttpCode String No http_2xx,http_3xx

The HTTP status code indicating that a health check is successful. Separate multiple HTTP status codes with commas (,).

Valid values:http_2xx, http_3xx, http_4xx, and http_5xx.

Note This parameter only takes effect when the HealthCheck parameter is set to on.
VServerGroup String No on

Specifies whether to use a VServer group.

Valid values: on and off.

VServerGroupId String No rsp-cige6j*****

The ID of the VServer group.

XForwardedFor_SLBIP String No on

Specifies whether to use the SLB-IP header to obtain the real IP address of the client.

Valid values: on and off.

XForwardedFor_SLBID String No on

Specifies whether to use the SLB-ID header to obtain the ID of the SLB instance.

Valid values: on and off.

XForwardedFor_proto String No on

Specifies whether to use the X-Forwarded-Proto header to obtain the listener protocol of the SLB instance.

Valid values: on and off.

Gzip String No on

Specifies whether to enable Gzip compression to compress files of a specific type.

Valid values: on and off.

AclId String No 123

The ID of the Access Control List (ACL) to which the listener is bound.

This parameter is required when the AclStatus parameter is set to on.

AclType String No white

The type of the Access Control List (ACL). Valid values: white and black.

  • white: Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. The whitelist is used to allow only specified IP addresses to access an application.

    Enabling the whitelist may pose risks to your workloads.

    After the whitelist is enabled, only the IP addresses in the ACL can access the SLB listener.

    If a whitelist is enabled and no IP address is specified, the SLB listener does not forward any requests.

  • black: All requests from the IP addresses or CIDR blocks in the ACL are denied. The blacklist is used to forbid specified IP addresses from accessing an application.

    If a blacklist is enabled and no IP address is specified, the SLB listener will forward all requests.

Note This parameter only takes effect when the AclStatus parameter is set to on.
AclStatus String No off

Specifies whether to enable access control for the listener.

Valid values: on and off.

IdleTimeout Integer No 12

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

If no request is received during the specified timeout period, SLB closes the connection and starts a new connection when it receives a new connection request.

RequestTimeout Integer No 3

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

If the backend server does not respond within the specified timeout period, SLB returns an HTTP 504 error to the client.

Description String No test

The description of the listener.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=SetLoadBalancerHTTPListenerAttribute
&ListenerPort=80
&LoadBalancerId=lb-bp1qjwo61pqz3ah*****
&<Common request parameters>

Sample success responses

XML format

<SetLoadBalancerHTTPListenerAttributeResponse>
      <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
</SetLoadBalancerHTTPListenerAttributeResponse>

JSON format

"RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
        }

Error codes

For a list of error codes, visit the API Error Center.