CreateLoadBalancerTCPListener - ENS - Alibaba Cloud Documentation Center

Creates a Transmission Control Protocol (TCP) listener.

Operation description

You can call this operation up to 100 times per second per account.
You can call this operation up to 10 times per second per user.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:CreateLoadBalancerTCPListener	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the Edge Load Balancer (ELB) instance.	lb-5ovkn1piwqmoqrfjdyhq4****
ListenerPort	integer	Yes	The listener port that is used by Edge Load Balancer (ELB) to receive requests and forward the requests to backend servers. Valid values: 1 to 65535.	80
Description	string	No	The name of the listener. The value must be 1 to 80 characters in length. Note The value cannot start with `http://` or `https://`.	example
Scheduler	string	No	The scheduling algorithm. Valid values: wrr (default): Backend servers with higher weights receive more requests than backend servers with lower weights. wlc: Requests are distributed based on the weight and load of each backend server. The load refers to the number of connections on a backend server. If two backend servers have the same weight, the backend server that has fewer connections receives more requests. rr: Requests are distributed to backend servers in sequence. sch: consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server. qch: consistent hashing that is based on QUIC connection IDs. Requests that contain the same QUIC connection ID are distributed to the same backend server. iqch: consistent hashing that is based on specific three bytes of the iQUIC CIDs. Requests whose second to fourth bytes are the same are distributed to the same backend server.	wrr
PersistenceTimeout	integer	No	The timeout period of session persistence. Default value: 0. If the default value is used, the system disables session persistence. Valid values: 0 to 3600. Unit: seconds.	0
EstablishedTimeout	integer	No	The timeout period of a connection. Valid values: 10 to 900. Default value: 900. Unit: seconds.	500
HealthyThreshold	integer	No	The number of consecutive successful health checks that must occur before an unhealthy and inaccessible backend server is declared healthy and accessible. Valid values: 2 to 10. Default value: 3.	4
UnhealthyThreshold	integer	No	The number of consecutive failed health checks that must occur before a healthy and accessible backend server is declared unhealthy and inaccessible. Valid values: 2 to 10. Default value: 3.	4
HealthCheckConnectTimeout	integer	No	The timeout period of a health check response. If a backend server does not respond within the specified timeout period, the server fails the health check. Default value: 5. Valid values: 1 to 300. Unit: seconds. Note If the value of the HealthCheckConnectTimeout parameter is smaller than that of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckConnectTimeout parameter is ignored and the period of time specified by the HealthCheckInterval parameter is used as the timeout period.	100
HealthCheckInterval	integer	No	The interval at which health checks are performed. Valid values: 1 to 50. Default value: 2. Unit: seconds.	3
HealthCheckDomain	string	No	The domain name that you want to use for health checks.	www.aliyundoc.com
HealthCheckURI	string	No	The Uniform Resource Identifier (URI) that you want to use for health checks. The URI must be 1 to 80 characters in length. Note The URL must start with `/` and contain characters other than `/`.	/checkpreload.htm
HealthCheckHttpCode	string	No	The HTTP status codes for a successful health check. Valid values: http_2xx (default) http_3xx. http_4xx http_5xx	http_2xx
HealthCheckType	string	No	The type of health checks. Valid values: tcp (default) http	tcp
BackendServerPort	integer	No	The port used by the backend ELB server of the ELB instance. Valid values: 1 to 65535.	8080
HealthCheckConnectPort	integer	No	The port that is used for health checks. Valid values: 1 to 65535. If you leave this parameter empty, the port specified for BackendServerPort is used for health checks.	8080
EipTransmit	string	No	Specifies whether to enable Elastic IP address (EIP) pass-through. Valid values: on off (default)	on

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	06F00FBB-3D9E-4CCE-9D43-1A6946A75456

Examples

Sample success responses

JSONformat

{
  "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.	The load balancing instance does not exist.
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.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-04	The Error code has changed	View Change Details