You can call the CreateLoadBalancerHTTPListener API to create an HTTP listener.

Note The status of a newly created listener is stopped. After you create an HTTP listener, you must call the StartLoadBalancerListener API to start the listener to forward traffic.

Debug

Click here to perform a debug operation in OpenAPI Explorer and automatically generate an SDK code example.

Request parameters

Name Type Required? Example value Description
Action String Yes CreateLoadBalancerHTTPListener

The action to perform. Valid value: CreateLoadBalancerHTTPListener

HealthCheck String Yes on

Whether to enable health checks. Valid values: on | off

ListenerPort Integer Yes 80

The frontend port used by the SLB instance. Valid values: 1–65535

LoadBalancerId String Yes lb-bp1c9vixxjh92q83tw1ae-cn-east-hangzhou-01

The ID of the SLB instance

RegionId String Yes cn-hangzhou

The region to which the SLB instance belongs.

You can query the region ID by referring to the list of regions and zones or by calling the DescribeRegions API.

StickySession String Yes off

Whether to enable session persistence.

Valid values: on | off

AclId String No 123

The ID of the access control list bound to the listener.

If the value of AclStatus is on, this parameter is required.

AclStatus String No off

Whether to enable access control.

Valid values: on | off (default value)

AclType String No white

The access control type:

  • white: Indicates a whitelist. Only requests from the IP addresses or CIDR blocks in the selected access control lists are forwarded. It applies to scenarios where an application allows access only from specific IP addresses.
Enabling a whitelist poses some risks to your services.

After a whitelist is configured, only the IP addresses in the list can access the listener.

If you enable a whitelist without adding any IP addresses to the list, all requests are forwarded.

  • black: Indicates a blacklist. Requests from the IP addresses or CIDR blocks in the selected access control lists are not forwarded (that is, they are blocked). It applies to scenarios where an application denies access only from specific IP addresses.
If you enable a blacklist without adding any IP addresses to the list, all requests are forwarded.

If the value of AclStatus is on, this parameter is required.

BackendServerPort Integer No 80

The backend port used by the SLB instance.

Valid values: 1–65535

Note If no VServer group is used (that is, the VServerGroupId parameter is not specified), this parameter is required.
Bandwidth Integer No -1

The peak bandwidth of the listener. Valid values:

  • -1: The peak bandwidth is not limited.
  • 1–5000: the peak bandwidth of the listener. The sum of the peak bandwidth values of all listeners cannot surpass the peak bandwidth of the instance.
Note This parameter applies only to the China site.
Cookie String No B490B5EBF6F3CD402E515D22BCDA1598

The cookie configured on the backend server.

The cookie must be 1 to 200 characters in length and can only contain ASCII English letters and numbers. It cannot contain commas (,), semicolons (;), or spaces, nor can it begin with $.

When the value of StickySession is on and the value of StickySessionType is server, this parameter is required.

CookieTimeout Integer No 500

Timeout period of the cookie.

Valid values: 1–86400 (seconds).

Note This parameter is required when the value of StickySession is on, and the value of StickySessionType is insert.
Description String No A description of the listener

A description of the listener.

The description must be 1 to 80 characters in length and can contain letters, numbers, hyphens (-), slashes (/), periods (.), and underscores (_). Chinese characters are supported.

ForwardPort Integer No 443

The port used for redirecting from HTTP to HTTPS

Gzip String No on

Whether to enable Gzip compression to compress a specific file type. Default value: on.

Valid values: on | off.

HealthCheckConnectPort Integer No 80

The port of the backend server for health checks.

Valid values: 1–65535

HealthCheckDomain String No $_ip

The domain name used for health checks. Valid values:

  • $_ip: the private IP address of the backend server. If the IP address is specified or this parameter is not specified, SLB uses 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, and can only contain letters, numbers, periods (.), and hyphens (-).
HealthCheckHttpCode String No http_2xx,http_3xx

The HTTP status code indicating that the health check is normal. Separate multiple HTTP status codes by commas. Default value: http_2xx.

Valid values: http_2xx | http_3xx | http_4xx | http_5xx

HealthCheckInterval Integer No 5

The time interval between two consecutive health checks.

Valid values: 1–50 (seconds)

HealthCheckTimeout Integer No 3

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

Valid values: 1–300 (seconds)

Note If the value of HealthCheckInterval is greater than the value of HealthCheckTimeout, the HealthCheckTimeout parameter is invalid, and the timeout is set to the value of HealthCheckInterval.
HealthCheckURI String No /test/index.html

The URI used for health checks

HealthyThreshold Integer No 4

The number of consecutive successes of health checks before a backend server is declared as healthy (from failure to success).

Valid values: 2–10

IdleTimeout Integer No 3

Specify the idle connection timeout in seconds. Valid values: 1–60. Default value: 15.

If no request is received during the specified timeout period, SLB will temporarily terminate the connection and restart the connection when the next request is received.

ListenerForward String No off

Whether to enable redirecting from HTTP to HTTPS.

Valid values: on | off

RequestTimeout Integer No 6

Specify the request timeout in seconds. Valid values: 1–180. Default value: 60.

HTTP 504

Scheduler String No wrr

The algorithm used to distribute traffic. Valid values:

  • wrr (default value): A backend server with a higher weight is more likely to be polled.
  • wlc: A server with a higher weight will receive more requests. When the weight is the same, the backend server with a smaller number of connections is more likely to be polled.
  • rr: Requests are evenly and sequentially distributed to backend servers.
StickySessionType String No on

The method used to handle the cookie. Valid values:

  • insert: Insert a cookie.
SLB adds a cookie to the response (that is, it inserts SERVERID in the HTTP/HTTPS response packet) during the first client request. Then, the next request will contain the cookie and the listener will distribute the request to the same backend server.
  • server: Rewrite the cookie.
SLB will overwrite the original cookie when a new cookie is set. The next time the client carries the new cookie to access SLB, the listener will distribute the request to the previously recorded backend server.
Note If the value of StickySession is on, this parameter is required.
UnhealthyThreshold Integer No 4

The number of consecutive failures of health checks before a backend server is declared as unhealthy (from success to failure).

Valid values: 2 or 10

VServerGroupId String No rsp-cige6j5e7p

The ID of the VServer group

XForwardedFor String No on

Whether to use the X-Forwarded-For header field to obtain the real IP address of a client. Default value: on.

Valid values: on | off

XForwardedFor_SLBID String No on

SLB-ID

Valid values: on | off (default value)

XForwardedFor_SLBIP String No on

SLB-IP

Valid values: on | off (default value)

XForwardedFor_proto String No on

X-Forwarded-Proto

Valid values: on | off (default value)

Response parameters

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

The ID of the request

Examples

Request example


http(s)://[Endpoint]/? Action=CreateLoadBalancerHTTPListener
&HealthCheck=on
&ListenerPort=80
&LoadBalancerId=lb-bp1c9vixxjh92q83tw1ae-cn-east-hangzhou-01
&StickySession=off
&<CommonParameters>

Normal response examples

XML format

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

JSON format

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

Error codes

Click here to view the error codes.