DescribeLoadBalancerTCPListenerAttribute - Server Load Balancer

Queries the configuration of a TCP listener.

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

slb:DescribeLoadBalancerTCPListenerAttribute

get

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag
slb:tag
slb:tag
slb:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the Classic Load Balancer instance. Query the region ID from the Regions and zones list or by calling the DescribeRegions interface.	cn-hangzhou
LoadBalancerId	string	Yes	The ID of the Classic Load Balancer instance.	lb-bp1ygod3yctvg1y****
ListenerPort	integer	Yes	The frontend port used by the Classic Load Balancer instance. Valid values: 1 to 65535.	80

Response elements

Element	Type	Description	Example
	object
VServerGroupId	string	The ID of the attached vServer group.	rsp-cige6******8
Status	string	The current status of the listener. Valid values: running: The listener is running normally. stopped: The listener is stopped.	stopped
AclType	string	The access control type: white: Forwards requests only from the IP addresses or CIDR blocks configured in the selected access control policy group. Use a whitelist when an application allows access only from specific IP addresses. Setting a whitelist carries some business risks. Once you set a whitelist, only the IP addresses in the whitelist can access the SLB listener. If you enable whitelist access but add no IP addresses to the access policy group, the SLB listener forwards all requests. black: All requests from the IP addresses or CIDR blocks configured in the selected access control policy group are not forwarded. Use a blacklist when an application restricts access only from specific IP addresses. If you enable blacklist access but add no IP addresses to the access policy group, the SLB listener forwards all requests. Note This parameter is required when the value of the AclStatus parameter is on.	white
ConnectionDrainTimeout	integer	The connection draining timeout. This value is returned when ConnectionDrain is set to on. Valid values: 10 to 900 seconds.	300
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710
HealthCheckConnectPort	integer	The port used for health checks. Valid values: 1 to 65535. If you do not set this parameter, the backend service port (BackendServerPort) is used.	8080
Description	string	The custom listener name.	TCP_80
Bandwidth	integer	The peak bandwidth of the listener. Unit: Mbps. Valid values: -1: For an Internet-facing SLB instance that uses the pay-by-data-transfer billing method, set the peak bandwidth to -1 to indicate no bandwidth limit. 1 to 5120: For an Internet-facing SLB instance that uses the pay-by-bandwidth billing method, set the peak bandwidth for each listener. The sum of the peak bandwidths of all listeners cannot exceed the peak bandwidth of the instance.	-1
HealthCheckType	string	The health check method for the TCP listener. Valid values: tcp or http.	tcp
MasterSlaveServerGroupId	string	The ID of the attached primary/secondary server group.	rsp-0bfucw****
BackendServerPort	integer	The backend port used by the Classic Load Balancer instance. Note This parameter is not displayed when the backend server group is a vServer group.	443
AclStatus	string	Indicates whether access control is enabled. Valid values: on: Enabled. off: Disabled.	off
HealthCheckDomain	string	The domain name used for health checks. Valid values: $_ip: The private IP address of the backend server. If you specify an IP address or do not specify this parameter, Server Load Balancer uses the private IP address of each backend server as the domain name for health checks. domain: The domain name is 1 to 80 characters in length. It can contain letters, digits, periods (.), and hyphens (-).	www.domain.com
UnhealthyThreshold	integer	The unhealthy threshold. After health checks consecutively fail for the specified number of times, the health check status of the backend server changes from success to failed. Valid values: 2 to 10.	4
HealthCheckHttpCode	string	The HTTP status code for a successful health check.	http_2xx
ProxyProtocolV2Enabled	boolean	Indicates whether Proxy Protocol is enabled to carry the client source IP address to backend servers. Valid values: true: Yes. false: No.	false
PersistenceTimeout	integer	The session persistence timeout. Valid values: 0 to 3600 seconds. Default value: 0, which means session persistence is disabled.	0
ListenerPort	integer	The frontend port used by the Classic Load Balancer instance.	110
HealthCheckInterval	integer	The interval between two consecutive health checks. Valid values: 1 to 50 seconds.	5
HealthCheckURI	string	The URL used for health checks. The URL is 1 to 80 characters in length. It can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL cannot be a single forward slash (/) but must start with a forward slash (/).	/test/index.html
AclId	string	The ID of the access policy group attached to the listener. This parameter is required when the value of the AclStatus parameter is on.	acl-uf60jwfi******
SynProxy	string	Indicates whether the SynProxy attack prevention feature of Server Load Balancer is enabled. Do not adjust this parameter under normal circumstances. Server Load Balancer controls it. enable: Enabled. disable: Disabled.	disable
Scheduler	string	The scheduling algorithm. Valid values: wrr (default): Backend servers with higher weights receive more requests. rr: Requests are distributed to backend servers in sequence. sch: Consistent hashing based on source IP addresses. Requests from the same source IP address are scheduled to the same backend server. tch: Consistent hashing based on quadruplets (source IP address, destination IP address, source port, and destination port). The same stream is scheduled to the same backend server. Note Only guaranteed-performance instances support the sch and tch consistent hashing algorithms.	wrr
EstablishedTimeout	integer	The connection timeout.	500
HealthCheckConnectTimeout	integer	The timeout period.	100
HealthyThreshold	integer	The healthy threshold. After health checks consecutively succeed for the specified number of times, the health check status of the backend server changes from failed to success. Valid values: 2 to 10.	4
ConnectionDrain	string	Indicates whether connection draining is enabled. This value is returned when ConnectionDrain is set to on. Valid values: on: Enabled. off: Disabled.	off
HealthCheckMethod	string	The health check method.	tcp
HealthCheck	string	Indicates whether health checks are enabled. Valid values: on: Enabled. off: Disabled.	on
AclIds	object
AclId	array	The list of access control policy group IDs.

LoadBalancerId	string	The ID of the Classic Load Balancer instance.	lb-bp1ygod3yctvg1y****
Tags	object
Tag	array<object>	The list of tags.
	object	The list of tags.
TagKey	string	The tag key of the listener. N is an integer from 1 to 20. If you specify this parameter, it cannot be an empty string. It can contain up to 128 characters and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	TestKey
TagValue	string	The tag value of the listener. N is an integer from 1 to 20. If you specify this parameter, it can be an empty string. It can contain up to 128 characters and cannot start with `acs:`. It cannot contain `http://` or `https://`.	TestValue

Examples

Success response

JSON format

{
  "VServerGroupId": "rsp-cige6******8",
  "Status": "stopped",
  "AclType": "white",
  "ConnectionDrainTimeout": 300,
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "HealthCheckConnectPort": 8080,
  "Description": "TCP_80",
  "Bandwidth": -1,
  "HealthCheckType": "tcp",
  "MasterSlaveServerGroupId": "rsp-0bfucw****",
  "BackendServerPort": 443,
  "AclStatus": "off",
  "HealthCheckDomain": "www.domain.com",
  "UnhealthyThreshold": 4,
  "HealthCheckHttpCode": "http_2xx",
  "ProxyProtocolV2Enabled": false,
  "PersistenceTimeout": 0,
  "ListenerPort": 110,
  "HealthCheckInterval": 5,
  "HealthCheckURI": "/test/index.html",
  "AclId": "acl-uf60jwfi******",
  "SynProxy": "disable",
  "Scheduler": "wrr",
  "EstablishedTimeout": 500,
  "HealthCheckConnectTimeout": 100,
  "HealthyThreshold": 4,
  "ConnectionDrain": "off",
  "HealthCheckMethod": "tcp",
  "HealthCheck": "on",
  "AclIds": {
    "AclId": [
      ""
    ]
  },
  "LoadBalancerId": "lb-bp1ygod3yctvg1y****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	LocationServiceTimeout	Location service connection timeout. Please try again later.
403	UnauthorizedRegion	The specified region of is not authorized.	The specified region of is not authorized.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.