Creates an HTTP listener.

Note Newly created listeners are in the stopped state. After a listener is created, you can call the StartLoadBalancerListener operation to enable the listener. This way, the listener can forward network traffic.

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 CreateLoadBalancerHTTPListener

The operation that you want to perform.

Set the value to CreateLoadBalancerHTTPListener.

HealthCheck String Yes on

Specifies whether to enable health checks. Valid values:

  • on: enables health checks.
  • off: disables health checks.
ListenerPort Integer Yes 80

The frontend port that is used by the Server Load Balancer (SLB) instance.

Valid values: 1 to 65535.

LoadBalancerId String Yes lb-bp1c9vixxjh92q83tw*****

The ID of the SLB instance.

StickySession String Yes off

Specifies whether to enable session persistence. Valid values:

  • on: enables session persistence.
  • off: disables session persistence.
RegionId String Yes cn-hangzhou

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

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

Bandwidth Integer No -1

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

  • -1: specifies that the maximum bandwidth is unlimited.
  • 1 to 5120: If you set the value to a number from 1 to 5120, the value that you specify indicates the maximum bandwidth value of the listener. The sum of maximum bandwidth values of all listeners cannot exceed the maximum bandwidth value of the SLB instance.
Note This parameter applies to only mainland China.
BackendServerPort Integer No 80

The backend port that is used by the SLB 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 obtain the real IP address of the client.

Valid values: on and off. Default value: off.

Scheduler String No wrr

The scheduling algorithm. Valid values:

  • wrr (default): Backend servers that have higher weights receive more requests than backend servers that have lower weights.
  • rr: Requests are distributed to backend servers in sequence.
StickySessionType String No insert

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

  • insert: inserts a cookie.

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

  • 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 forward the request to the recorded backend server.
    Note If you set the StickySession parameter to on, you must specify a value for this parameter.
CookieTimeout Integer No 500

The timeout period of a cookie.

Valid values: 1 to 86400. Unit: seconds.

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

The cookie to be configured on the backend server.

The value 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 If you set the StickySession parameter to on and the StickySessionType parameter to server, this parameter is required.
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 the backend server. If the $_ip parameter is set or the HealthCheckDomain parameter is not set, SLB uses the private IP addresses of backend servers as the domain names for health checks.
  • domain: The domain name must be 1 to 80 characters in length. It can contain only 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 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 URI must not be a single forward slash (/) but it must start with a forward slash (/).

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

Specifies the number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success).

Valid values: 2 to 10.

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

Specifies the number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy (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 does not respond within the specified time period, the backend server is declared unhealthy. This parameter takes effect only if the HealthCheck parameter is set to on.

Valid values: 1 to 300. Unit: seconds.

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 waiting period.
HealthCheckConnectPort Integer No 80

The port of the backend server 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 time interval between two consecutive health checks.

Valid values: 1 to 50. Unit: seconds.

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

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

Default value: http_2xx.

Valid values: http_2xx, 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 obtain the real IP address of the client.

Valid values: on and off. Default value: 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. Default value: 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. Default value: off.

Gzip String No on

Specifies whether to enable gzip compression to compress files of a specific type. Default value: on.

Valid values: on and off. Default value: off.

AclId String No 123

The ID of the access control list (ACL) to which the listener is bound.

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

AclType String No white

The type of ACL. Valid values:

  • white: specifies the ACL as a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists apply to scenarios that require you to allow only specific IP addresses to access an application.

    Risks may occur if the whitelist is improperly set.

    After you set a whitelist for an SLB listener, only requests from IP addresses that are added to the whitelist are distributed by the listener.

    If a whitelist is enabled without IP addresses specified, the SLB listener does not forward 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 the blacklist is enabled but the corresponding ACL does not contain IP addresses, the SLB listener forwards all requests.

This parameter takes effect if the AclStatus parameter is set to on.

AclStatus String No off

Specifies whether to enable the access control feature.

Valid values: on and off. Default value: off.

Description String No ListenerDescription

The description of the listener.

The name must be 1 to 80 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 and off. Default value: off.

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. Valid values: 1 to 60. Default value: 15.

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

RequestTimeout Integer No 6

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

If no response is received from the backend server within the specified timeout period, SLB 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]/?Action=CreateLoadBalancerHTTPListener
&HealthCheck=off
&ListenerPort=80
&LoadBalancerId=lb-bp1c9vixxjh92q83tw*****
&StickySession=off
&BackendServerPort=80
&<Common request parameters>

Sample success responses

XML format

<CreateLoadBalancerHTTPListenerResponse>
	  <RequestId>1FF504CB-BFFF-4508-A51A-58A416604FC8</RequestId>
</CreateLoadBalancerHTTPListenerResponse>

JSON format

{
    "RequestId": "1FF504CB-BFFF-4508-A51A-58A416604FC8"
}

Error codes

HttpCode Error code Error message Description
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 tcpssl 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 tcpssl 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.

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