Creates an HTTP listener for a Classic Load Balancer (CLB) instance.

Precautions

A newly created listener is in the stopped state. After a listener is created, you can call the StartLoadBalancerListener operation to start the listener. After the listener is started, the listener can forward traffic to backend servers.

Prerequisites

A Classic Load Balancer (CLB) instance is created. For more information, see CreateLoadBalancer.

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
RegionId String No cn-hangzhou

The ID of the region where the CLB instance is deployed.

You can query the region ID from the Regions and zones list or by calling the DescribeRegions operation.

Action String Yes CreateLoadBalancerHTTPListener

The operation that you want to perform. Set the value to CreateLoadBalancerHTTPListener.

LoadBalancerId String Yes lb-bp1c9vixxjh92q83tw*****

The ID of the CLB instance.

Bandwidth Integer No -1

The maximum bandwidth of the listener. Unit: Mbit/s. Valid values:

  • -1: If you set the value to -1, the bandwidth of the listener is unlimited.
  • 1 to 5120: The sum of bandwidth values that you specify for all listeners of the CLB instance cannot exceed the maximum bandwidth of the CLB instance.
Note This parameter is available only in the Chinese mainland.
ListenerPort Integer Yes 80

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

BackendServerPort Integer No 80

The backend port that is used by the CLB instance.

Valid values: 1 to 65535.

Note If the VServerGroupId parameter is not set, this parameter is required.
XForwardedFor String No on

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

  • on (default): yes
  • off: no
Scheduler String No wrr

The scheduling algorithm. Valid values:

  • wrr (default): Backend servers with higher weights receive more requests than backend servers with lower weights.
  • rr: Requests are distributed to backend servers in sequence.
StickySession String Yes off

Specifies whether to enable session persistence. Valid values:

  • on: yes
  • off (default): no
StickySessionType String No insert

The method that is used to handle a cookie. Valid values:

  • insert: inserts a cookie.

    CLB inserts a cookie (SERVERID) into the first HTTP or HTTPS response that is sent to a client. The next request from the client carries this cookie, and the listener will forward this request to the recorded backend server.

  • server: rewrites a cookie.

    When CLB detects a user-defined cookie, it overwrites the original cookie with the user-defined cookie. The next request from the client carries the user-defined cookie, and the listener forwards this request to the recorded backend server.
    Note This parameter is required if the StickySession parameter is set to on.
CookieTimeout Integer No 500

The timeout period of a cookie. Unit: seconds.

Valid values: 1 to 86400.

Note If StickySession is set to on and StickySessionType is set to insert, this parameter is required.
Cookie String No B490B5EBF6F3CD402E515D22BCDA1598

The cookie that is configured on the server.

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

Note This parameter is required if the StickySession parameter is set to on and the StickySessionType parameter is set to server.
HealthCheck String Yes on

Specifies whether to enable the health check feature. Valid values:

  • on: yes
  • off: no
HealthCheckMethod String No get

The health check method used in HTTP health checks. Valid values: head and get.

Note This parameter takes effect only if the HealthCheck parameter is set to on.
HealthCheckDomain String No 172.16.0.0/12

The domain name that is used for health checks. Valid values:

  • $_ip: the private IP address of a backend server. If you do not set the HealthCheckDomain parameter or set the parameter to $_ip, the CLB instance uses the private IP address of each backend server for health checks.
  • domain: The domain name must be 1 to 80 characters in length and can contain letters, digits, periods (.), and hyphens (-).
Note This parameter takes effect only if the HealthCheck parameter is set to on.
HealthCheckURI String No /test/index.html

The URI that is used for health checks.

The URI 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 URI must start with a forward slash (/) but cannot be a single forward slash (/).

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

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status is changed from fail to success.

Valid values: 2 to 10.

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

The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status is changed from success to fail.

Valid values: 2 to 10.

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

The timeout period of a health check response. If a backend server, such as an Elastic Compute Service (ECS) instance, does not respond to a probe packet within the specified timeout period, the server fails the health check. Unit: seconds.

Valid values: 1 to 300.

Note
  • If the value of the HealthCheckTimeout parameter is smaller than that of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckTimeout parameter is ignored and the period of time specified by the HealthCheckInterval parameter is used as the timeout period.
  • This parameter takes effect only if the HealthCheck parameter is set to on.
HealthCheckConnectPort Integer No 80

The backend port that is used for health checks.

Valid values: 1 to 65535.

Note This parameter takes effect only if the HealthCheck parameter is set to on.
HealthCheckInterval Integer No 5

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

Valid values: 1 to 50.

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

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

Valid values: http_2xx (default), http_3xx, http_4xx, and http_5xx.

Note This parameter takes effect only if the HealthCheck parameter is set to on.
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 retrieve the virtual IP address (VIP) of the client. Valid values:

  • on: yes
  • off (default): no
XForwardedFor_SLBID String No on

Specifies whether to use the SLB-ID header to retrieve the ID of the CLB instance. Valid values:

  • on: yes
  • off (default): no
XForwardedFor_proto String No on

Specifies whether to use the X-Forwarded-Proto header to retrieve the listening protocol. Valid values:

  • on: yes
  • off (default): no
Gzip String No on

Specifies whether to enable Gzip compression to compress specific types of files. Valid values:

  • on (default): yes
  • off: no
AclId String No 123

The ID of the network ACL that is associated with the listener.

Note If AclStatus is set to on, this parameter is required.
AclType String No white

The type of the network ACL. Valid values:

  • white: a whitelist. Only requests from the IP addresses or CIDR blocks in the network ACL are forwarded. Whitelists apply to scenarios where you want to allow only specific IP addresses to access an application. Your service may be adversely affected if the whitelist is not properly configured. If a whitelist is configured, only requests from IP addresses that are added to the whitelist are forwarded by the listener.

    If you enable a whitelist but do not add an IP address to the ACL, the listener forwards all requests.

  • black: a blacklist. All requests from the IP addresses or CIDR blocks in the ACL are rejected. Blacklists apply to scenarios where you want to block access from specified IP addresses to an application.

    If a blacklist is configured for a listener but no IP address is added to the blacklist, the listener forwards all requests.

Note If AclStatus is set to on, this parameter is required.
AclStatus String No off

Specifies whether to enable access control. Valid values:

  • on: yes
  • off (default): no
Description String No HTTP_443

The name of the listener.

The name must be 1 to 256 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_).

ListenerForward String No off

Specifies whether to enable HTTP-to-HTTPS redirection. Valid values:

  • on: yes
  • off (default): no
ForwardPort Integer No 443

The listening port that is used to redirect HTTP requests to HTTPS.

IdleTimeout Integer No 3

The timeout period of an idle connection. Unit: seconds.

Default value: 15. Valid values: 1 to 60.

If no request is received within the specified timeout period, SLB closes the connection. When a request is received, SLB establishes a new connection.

RequestTimeout Integer No 6

The timeout period of a request. Unit: seconds.

Default value: 60. Valid values: 1 to 180.

If no response is received from the backend server within the specified timeout period, CLB sends an HTTP 504 error code to the client.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&Action=CreateLoadBalancerHTTPListener
&LoadBalancerId=lb-bp1c9vixxjh92q83tw*****
&Bandwidth=-1
&ListenerPort=80
&BackendServerPort=80
&XForwardedFor=on
&Scheduler=wrr
&StickySession=off
&StickySessionType=insert
&CookieTimeout=500
&Cookie=B490B5EBF6F3CD402E515D22BCDA1598
&HealthCheck=on
&HealthCheckMethod=get
&HealthCheckDomain=172.16.0.0/12
&HealthCheckURI=/test/index.html
&HealthyThreshold=4
&UnhealthyThreshold=4
&HealthCheckTimeout=3
&HealthCheckConnectPort=80
&HealthCheckInterval=5
&HealthCheckHttpCode=http_2xx
&VServerGroupId=rsp-cige6j*****
&XForwardedFor_SLBIP=on
&XForwardedFor_SLBID=on
&XForwardedFor_proto=on
&Gzip=on
&AclId=123
&AclType=white
&AclStatus=off
&Description=HTTP_443
&ListenerForward=off
&ForwardPort=443
&IdleTimeout=3
&RequestTimeout=6
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 InvalidParameter.RegionNotSupport The region does not support the parameter: %s. The error message returned because the parameter is not supported in the current region.
400 IpVersionConflict The ip version of this LoadBalancer and the Acl is conflict. The error message returned because the specified IP version is not supported by the network ACL.
400 InvalidParameter The specified ListenerPort or ForwardPort is invalid. The error message returned because ListenerPort or ForwardPort is set to an invalid value. Specify a valid value and try again.
400 ListenerForwardNotSupport X-Forward-For is not supported to a ipv6 instance. The error message returned because the X-Forward-For header is not supported by SLB instances that have IPv6 enabled.
400 InvalidParameter.IdleTimeout The specified IdleTimeout exceeds the limit. The error message returned because IdleTimeout is set to an invalid value. Specify a valid value and try again.
400 InvalidParameter.RequestTimeout The specified RequestTimeout exceeds the limit. The error message returned because RequestTimeout is set to an invalid value. Specify a valid value and try again.
400 ListenerProcessing A previous configuration of the listener is pending,please try again later. The error message returned because the specified instance is being configured. Try again later.
400 InvalidParameter.ListenerPortConflict There is conflict listener port exists. The error message returned because the specified listening port already exists.
400 ResourceNotAvailible.HttpListener The specified Zone did not have enough resource. The error message returned because resources are insufficient in the specified zone.
400 AclNotExist Acl does not exist. The error message returned because the specified network ACL does not exist.
400 OperationUnsupported.CreateLoadBalancerLayer7Listener The slb instance does not support create HTTP or HTTPS listener. The error message returned because the specified CLB instance does not support HTTP or HTTPS listeners.
400 InvalidParameter.VServerGroupId The MasterSlaveServerGroup can not be attached to HTTP or HTTPS listener. The error message returned because HTTP and HTTPS listeners do not support primary/secondary server groups.
400 MissingParam.HealthCheckDomain The HealthCheckDomain is required when HealthCheckHttpVersion is http1.1. The error message returned because the HealthCheckDomain parameter is not set.
400 InvalidParameter.HealthCheckHttpVersion The param HealthCheckHttpVersion is invalid. The error message returned because HealthCheckHttpVersion is set to an invalid value. Specify a valid value and try again.
400 QuotaLimitExceeds.AclAttachedToListener %s. The error message returned because the number of listeners associated with the network ACL has reached the upper limit.
400 QuotaLimitExceeds.TotalAclEntry %s. The error message returned because the number of network ACL rules has reached the upper limit.
400 Duplicated.AclEntry %s. The error message returned because the specified ACL rule already exists.
400 OperationFailed.InsufficientResources The loadbalancer does not support this operation because of insufficient resources. The error message returned because the operation failed due to insufficient resources.
400 InvalidParameter.ForwardCode The specified ForwardCode is invalid. The error message returned because ForwardCode is set to an invalid value. Specify a valid value and try again.
400 LbNotSupportTcpssl You cannot create a TCP SSL type listener for the specified load balancer. The error message returned because the specified instance does not allow you to create TCP SSL listeners.
400 LbSupportTcpsslOnly The specified load balancer supports TCP SSL type listener only. The error message returned because the specified instance allows you to create only TCP SSL listeners.
400 ListenerNotSupportRule You cannot create a rule for the specified listener. The error message returned because the specified listener does not allow you to create forwarding rules.
400 Mismatch.SlbSpecTypeAndListenerProtocol The SlbSpecType and ListenerProtocol are mismatched. The error message returned because the specified instance type and listener type do not match.

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