DescribeLoadBalancerHTTPListenerAttribute

Description

call DescribeLoadBalancerHTTPListenerAttribute to query HTTP listening configuration.

Request Method

POST

Request Path

/apsara/route/Slb/DescribeLoadBalancerHTTPListenerAttribute

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-bp1o94dp5****	ID of the load balancing instance.
version	BODY	string	No	2016-01-01	version of api
Tags	BODY	string	No	{"tagKey":"Key1","tagValue":"Value1"}	tag key and value.

Return data

Name	Type	Sample value	Description
CookieTimeout	integer	500	Cookie timeout.
MaxConnection	integer	10	Maximum number of connections.
VServerGroupId	string	rsp-cige6j****	bound server group ID.
Description	string	test	HTTP listening description. It is 1 to 80 characters in length and supports Chinese descriptions, as well as letters, numbers, dashes (-), forward slashes (/), periods (.), and underscores (_).
UnhealthyThreshold	integer	4	unhealthy check threshold.
Scheduler	string	wrr	scheduling algorithm. Value:wrr, wlc or rr. 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. /p> p data-tag = "p" class = "p"> span data-tag = "text" class = "text"> is limited to 1-80 characters in length and supports letters, numbers and dashes (-), forward slashes (/), half-angle period (.), percent sign (%), half-angle question mark (?), pound sign (#) and (& 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.
IdleTimeout	integer	2	specify the connection idle timeout time, the value range is 1~60 seconds, the default value is 15 seconds. /span>/p> p data-tag = "p" class = "p"> there has been no access request during the timeout period. load balancing will temporarily interrupt the current connection until the next request comes to temporarily re-establish a new connection.
BackendServerPort	integer	80	the port used by the backend of the load balancing instance.
XForwardedFor_SLBID	string	on	whether to pass SLB-ID header field to obtain the load balancing instance ID.
HealthCheckConnectPort	integer	8080	health check port. description when HealthCheck value is on is valid.
Bandwidth	integer	-1	The peak bandwidth of the monitor, in Mbps. Value: -1: no bandwidth peak value is limited. 1~5120: the peak bandwidth of listening, the sum of the peak bandwidth of all listeners cannot exceed the peak bandwidth of the instance. Description This parameter is only applicable to Mainland China.
SecurityStatus	string	on	security status. Value:on or off.
Gzip	string	on	Whether to turn on Gzip compression to compress specific file types. Value:on or off.
StickySessionType	string	insert	Cookie processing method. Value:insert or server. insert: insert cookies. /ul> p data-tag = "p" class = "p"> when the client accesses for the first time, the load balancing service will insert a cookie into the return request (I .e. insert a ServerId into the HTTP or HTTPS response message). the next time the client carries this cookie for access, the load balancing service will directionally forward the request to the back-end server previously recorded. server: rewrite the cookie. /ul> p data-tag = "p" class = "p"> load balancing finds that the user has customized the cookie, and will rewrite the original cookie. next time the client carries a new cookie to access, the load balancing service will directionally forward the request to the previously recorded back-end server. description when StickySession the value is on, this parameter must be specified.
XForwardedFor_SLBIP	string	on	whether to pass SLB-IP header field obtains the real IP of the client request.
HealthCheckHttpCode	string	http_2xx	normal HTTP status code for health check, multiple status codes are divided by commas (,). Value:http_2xx(default), http_3xx, http_4xx or http_5xx. description in HealthCheck value is on is valid.
Status	string	stopped	the current status of listening. Value:running or stopped. running: indicates that the listening is running normally. stopped: Indicates that the listening is stopped.
Cookie	string	B490B5EBF6F3CD402E515D22BCDA1598	Cookie configured on the server. 1 to 200 characters in length, can only contain ASCII English letters and numeric characters, cannot contain commas (,), semicolons (;) or spaces, and cannot start with the dollar sign ($).
ListenerPort	integer	80	the port used by the front end of the load balancing instance.
RequestTimeout	integer	34	specify the request timeout time, the value range is 1~180 seconds, the default value is 60 seconds. /span>/p> p data-tag = "p" class = "p"> the back-end server has not responded during the timeout period. load balancing will give up waiting and return the HTTP 504 error code to the client.
HealthCheckInterval	integer	5	the time interval for health check, with a value of 1~50 seconds.
RequestId	string	365F4154-92F6-4AE4-92F8-7FF34B540710	request ID.
HealthCheckTimeout	integer	3	the maximum excess time of each health check response, with a value of 1~300 seconds.
ListenerForward	string	on	indicates whether to enable HTTP to HTTPS listening and forwarding. on: indicates on. off: indicates that it is not turned on.
StickySession	string	on	whether to enable session persistence. Value:on or off(default value).
ForwardPort	integer	80	HTTP to HTTPS listening and forwarding port. description if ListenerForward the value is off, this parameter is not displayed.
HealthyThreshold	integer	4	health check threshold.
XForwardedFor	string	on	whether to turn on obtaining the real IP of visitors by X-Forwarded-For. Value:on or off.
HealthCheckDomain	string	www.domain.com	domain name used for health check.
XForwardedFor_proto	string	on	whether to pass X-Forwarded-Proto the header field obtains the listening protocol of the load balancing instance.

Example

Successful Response example

{
 "CookieTimeout":"500",
 "MaxConnection":"10",
 "VServerGroupId":"rsp-cige6j****",
 "Description":"test",
 "UnhealthyThreshold":"4",
 "Scheduler":"wrr",
 "HealthCheckURI":"/test/index.html",
 "HealthCheck":"on",
 "IdleTimeout":"2",
 "BackendServerPort":"80",
 "XForwardedFor_SLBID":"on",
 "HealthCheckConnectPort":"8080",
 "Bandwidth":"-1",
 "SecurityStatus":"on",
 "Gzip":"on",
 "StickySessionType":"insert",
 "XForwardedFor_SLBIP":"on",
 "HealthCheckHttpCode":"http_2xx",
 "Status":"stopped",
 "Cookie":"B490B5EBF6F3CD402E515D22BCDA1598",
 "ListenerPort":"80",
 "RequestTimeout":"34",
 "HealthCheckInterval":"5",
 "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
 "HealthCheckTimeout":"3",
 "ListenerForward":"on",
 "StickySession":"on",
 "ForwardPort":"80",
 "HealthyThreshold":"4",
 "XForwardedFor":"on",
 "HealthCheckDomain":"www.domain.com",
 "XForwardedFor_proto":"on"
}

Failed Response example

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

}