edit-icon download-icon

CreateLoadBalancerTCPListener

Last Updated: Apr 18, 2018

Description

Create a TCP listener.

Note: After the listener is created, the listener status is stopped. Call the StartLoadBalancerListener API to start the listener to distribute traffic.

Request parameter

Name Type Required Description
Action String Yes

The action to perform. Valid value:

CreateLoadBalancerTCPListener

RegionId String Yes The ID of the region where the SLB instance is located.
LoadBalancerId String Yes The ID of the SLB instance for which the TCP listener is created.
ListenerPort Integer Yes

The front-end port of the listener that is used to receive incoming traffic and distribute the traffic to the backend servers.

Valid value: [1, 65535]

BackendServerPort Integer No

The port opened on the backend server to receive requests.

Valid value: [1, 65535]

Note: If the VServerGroupId parameter is not specified, this parameter is required.

Bandwidth Integer Yes

The peak bandwidth of the listener. Valid value: [1,1000] Mbps

Note: Set it to -1 if the Internet SLB instance is charged by traffic.

Scheduler String No

The algorithm used to distribute traffic. Valid value:

  • wrr (Default)

    Backend servers with higher weights receive more requests than those with smaller weights.

  • wlc

    A server with a higher weight will receive a larger percentage of live connections at any one time. If the weights are the same, the system directs network connections to the server with the fewest established connections.

  • rr

    Requests are evenly and sequentially distributed to the backend servers.

VServerGroupId String No

The ID of a VServer group.

The VServerGroupId parameter and the MasterSlaveServerGroupId parameter cannot be used at the same time.

MasterSlaveServerGroupId String No

The ID of a master-slave server group.

The VServerGroupId parameter and the MasterSlaveServerGroupId parameter cannot be used at the same time.

EstablishedTimeout Integer No

The connection timeout in seconds for the Layer-4 TCP listener.

Valid value: [10, 900]. The default value is 900.

PersistenceTimeout Integer No

The timeout value of the TCP connection in seconds. Valid value: [10,900]

Note: By default, this value is set to zero, the session persistence function is disabled.

AclStatus String No

Specify whether to enable the access control function.

Valid value: on | off (Default)

AclType String No

Select an access control method after enabling the access control function:

  • whitelist: Only requests from IP addresses or CIDR blocks in the selected access control lists are forwarded. It applies to scenarios where the application only allows access from some specific IP addresses.

    Enabling whitelist poses some business risks. If you enable the whitelist without adding any IP entry in the corresponding access control list, no requests are forwarded.

  • blacklist: Requests from IP addresses or CIDR blocks in the selected access control lists are not forwarded. It applies to scenarios where the application only denies access from some specific IP addresses.

    If you enable a blacklist without adding any IP entry in the corresponding access control list, all requests are forwarded.

This parameter is required if the value of the AclStatus parameter is on.

AclId String No

Select an access control list as the whitelist or the blacklist. For more information, see Configure an access control list.

This parameter is required if the value of the AclStatus parameter is on.

HealthCheckType String No

Select a health check method. Valid value:

tcp (Default) | http

HealthCheckDomain String No

The domain name used for health check.

By default, Server Load Balancer sends an HTTP head request to the default homepage configured on the application server through the intranet IP address of the backend ECS instance to do the health check.

If your backend server verifies the host field in the request, you must configure a domain name to make sure the health check works.

You can specify the IP address of host to do the health check in the form of $_ip.

Note: This parameter is used only when the HTTP health check method is used.

HealthCheckURI String No

The URI used for health check.

Note: This parameter is used only when the HTTP health check method is used.

HealthCheckConnectPort Integer No

The port used for health check.

Valid value: [1, 65535]

HealthyThreshold Integer No

The number of consecutive successes of health check performed by the same LVS mode server on the same ECS instance (from failure to success).

Valid value: [2,10]

UnhealthyThreshold Integer No

The number of consecutive failures of health check performed by the same LVS node server on the same ECS instance (from success to failure).

Valid value: [2,10]

HealthCheckTimeout Integer No

The amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails.

Valid value: [1,300]

Note: If the value of the HealthCheckInterval is greater than the value of the HealthCHeckTimeout parameter, the timeout is set to the value of the HealthCheckInterval parameter.

HealthCheckInterval Integer No

The time interval between two consecutive health checks.

Valid value: [1,50]

HealthCheckHttpCode String No

The HTTP status code indicating that the health check is normal. Separate multiple HTTP status codes by commas (,).

Valid values: http_2xx (Default) | http_3xx | http_4xx | http_5xx

Default: http_2xx.

Note: This parameter is used only when the HTTP health check method is used.

Response parameter

Name Type Description
RequestId String The ID of the request.

Example

Request example

  1. https://slb.aliyuncs.com/?Action=CreateLoadBalancerTCPListener
  2. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  3. &ListenerPort=80
  4. &BackendServerPort=80
  5. &Bandwidth=-1
  6. &VServerGroupId=rsp-cige6j5e7p
  7. &<CommonParameters>

Response example

  • XML format

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <CreateLoadBalancerTCPListenerResponse>
    3. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    4. </CreateLoadBalancerTCPListenerResponse>
  • JSON format

    1. {
    2. "RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
    3. }
Thank you! We've received your feedback.