DescribeLoadBalancerTCPListenerAttribute

Description

call DescribeLoadBalancerTCPListenerAttribute to query TCP listening configuration.

Request Method

POST

Request Path

/apsara/route/Slb/DescribeLoadBalancerTCPListenerAttribute

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
ListenerPort	BODY	integer	Yes	80	the port used by the front end of the load balancing instance. value:1~65535.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
LoadBalancerId	BODY	string	Yes	lb-bp1ygod3yctvg1y****	ID of the load balancing instance.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
Status	string	stopped	the current status of listening. Value:running or stopped. running: listening is running normally. stopped: listening stopped.
MaxConnection	integer	10	Maximum number of connections.
ListenerPort	integer	80	the port used by the front end of the load balancing instance.
VServerGroupId	string	rsp-cige6******8	bound server group ID.
SynProxy	string	enable	whether to turn on SynProxy. SynProxy is the attack protection function of load balancing. it is recommended that users do not adjust this parameter under normal circumstances, and it is controlled by load balancing. enable: on. disable: closed.
HealthCheckInterval	integer	5	the interval of health check, in seconds.
Description	string	description.	listening description. The length is limited to 1 to 80 characters, including letters, numbers, dashes (-), forward slashes (/), periods (.), and underscores (_). Chinese description is supported.
RequestId	string	365F4154-92F6-4AE4-92F8-7FF34B540710	request ID.
UnhealthyThreshold	integer	4	unhealthy check threshold.
Scheduler	string	wrr	scheduling algorithm. wrr(Default value): The backend server with the higher the weight value, the higher the number of times (probability) it is polled. wlc: In addition to polling according to the weight value set by each back-end server, the actual load of the back-end server (that is, the number of connections) is also considered. When the weight value is the same, the number of times (probability) that the backend server with the smaller the current number of connections is polled is higher. rr: distribute external requests to backend servers in sequence according to the access order.
HealthCheckURI	string	/test/index.html	URI for health check. length is limited to 1~80, only letters, numbers and -/.%? &# amp;amp; these characters. The URL cannot only be a forward slash (/), but must start with a forward slash (/).
HealthCheck	string	on	whether to turn on health check. Value:on or off.
HealthCheckConnectTimeout	integer	100	timeout time.
BackendServerPort	integer	80	the port used by the backend of the load balancing instance. Description When the back-end server group is a virtual server group, this parameter is not displayed.
PersistenceTimeout	integer	0	whether session persistence is enabled. when the value is 0, indicates that it is not turned on.
HealthCheckConnectPort	integer	8080	port used for health check.
Bandwidth	integer	-1	The peak bandwidth of the monitor, in Mbps. Value: -1: for public network load balancing instances charged by traffic, the bandwidth peak value can be set to -1, that is, the bandwidth peak value is not limited. 1~5120: for a public network load balancing instance that is billed by bandwidth, you can set the peak bandwidth of each listener, but the sum of the peak bandwidth of all listeners cannot exceed the peak bandwidth of the instance.
HealthyThreshold	integer	4	health check threshold.
HealthCheckDomain	string	www.domain.com	domain name used for health check.
MasterSlaveServerGroupId	string	rsp-0bfucw****	the id of the bound primary and standby server group.
HealthCheckHttpCode	string	http_2xx	HTTP status code for normal health check. Value:http_2xx(default), http_3xx, http_4xx or http_5xx.
HealthCheckType	string	tcp	The health check method of TCP protocol listening. Value:tcp or http.
EstablishedTimeout	integer	500	connection timeout. Valid values:10~900 seconds.

Example

Successful Response example

{
 "Status":"stopped",
 "MaxConnection":"10",
 "ListenerPort":"80",
 "VServerGroupId":"rsp-cige6******8",
 "SynProxy":"enable",
 "HealthCheckInterval":"5",
 "Description":"description.",
 "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
 "UnhealthyThreshold":"4",
 "Scheduler":"wrr",
 "HealthCheckURI":"/test/index.html",
 "HealthCheck":"on",
 "HealthCheckConnectTimeout":"100",
 "BackendServerPort":"80",
 "PersistenceTimeout":"0",
 "HealthCheckConnectPort":"8080",
 "Bandwidth":"-1",
 "HealthyThreshold":"4",
 "HealthCheckDomain":"www.domain.com",
 "MasterSlaveServerGroupId":"rsp-0bfucw****",
 "HealthCheckHttpCode":"http_2xx",
 "HealthCheckType":"tcp",
 "EstablishedTimeout":"500"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}