Use CreateLoadBalancerTCPListener to create a TCP listener for an Edge Load Balancer - ENS - Alibaba Cloud - ENS

To create a TCP listener, call CreateLoadBalancerTCPListener.

Operation description

API call rate: 100 requests per second.
Per-user call rate: 10 requests per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:CreateLoadBalancerTCPListener

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the load balancer instance.	lb-5ovkn1piwqmoqrfjdyhq4****
ListenerPort	integer	Yes	The listener port that receives and forwards requests to backend servers. Valid values: 1 to 65535.	80
Description	string	No	The description of the listener. The description must be 1 to 80 characters in length. Note The description cannot start with `http://` or `https://`.	example
Scheduler	string	No	The scheduling algorithm. Valid values: wrr (default): Weighted Round Robin. Requests are distributed to backend servers based on their weights. Backend servers with higher weights receive more requests. wlc: Weighted Least Connections. Requests are distributed to backend servers based on both their weights and the number of connections. If multiple backend servers have the same weight, the one with the fewest connections receives more requests. rr: Round Robin. Requests are distributed to backend servers in sequential order. sch: Source IP Hash. Requests are routed based on a consistent hash of the source IP address, ensuring that requests from the same source IP address are sent to the same backend server. tch: Four-tuple Hash. Requests are routed based on a consistent hash of a four-tuple (source IP address, destination IP address, source port, and destination port), ensuring that requests from the same flow are sent to the same backend server.	wrr
PersistenceTimeout	integer	No	The timeout period for session persistence. Default value: 0, which indicates that session persistence is disabled. Valid values: 0 to 3600. Unit: seconds.	0
EstablishedTimeout	integer	No	The timeout period for established connections, in seconds. Valid values: 10 to 900. Default value: 900.	500
HealthyThreshold	integer	No	The number of consecutive successful health checks required for a backend server to be considered healthy (from a `fail` to `success` state). Valid values: 2 to 10. Default value: 3.	4
UnhealthyThreshold	integer	No	The number of consecutive failed health checks required for a backend server to be considered unhealthy (from a `success` to `fail` state). Valid values: 2 to 10. Default value: 3.	4
HealthCheckConnectTimeout	integer	No	The maximum time to wait for a health check response. If a backend ENS instance does not respond within this timeout period, the health check fails. Default value: 5. Valid values: 1 to 300. Unit: seconds. Note If the value of this parameter is less than the value of `HealthCheckInterval`, this parameter is ignored and the value of `HealthCheckInterval` is used as the timeout period.	100
HealthCheckInterval	integer	No	The interval between health checks, in seconds. Valid values: 1 to 50. Default value: 2.	3
HealthCheckDomain	string	No	The domain name used for health checks.	www.aliyundoc.com
HealthCheckURI	string	No	The URI for health checks. The URI must be 1 to 80 characters in length. Note The URI must start with a forward slash (/) but cannot be only a forward slash (/).	/checkpreload.htm
HealthCheckHttpCode	string	No	The HTTP status codes that indicate a successful health check. Valid values: http_2xx (default) http_3xx http_4xx http_5xx	http_2xx
HealthCheckType	string	No	The health check type. Valid values: tcp (default) http	tcp
BackendServerPort	integer	No	The port used by backend servers. Valid values: 1 to 65535.	8080
HealthCheckConnectPort	integer	No	The port used for health checks. Valid values: 1 to 65535. If you do not specify this parameter, the port specified by `BackendServerPort` is used by default.	8080
EipTransmit	string	No	Specifies whether to enable EIP passthrough. Valid values: on: Enables EIP passthrough. off (default): Disables EIP passthrough.	on

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	06F00FBB-3D9E-4CCE-9D43-1A6946A75456

Examples

Success response

JSON format

{
  "RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	LoadBalancerNotFound	The input parameter loadBalancerId that is not found.
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.	The current operation is not supported. The disk is being reset.
400	ListenerAlreadyExists	The listener already exists.	The listener already exists.
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.