DescribeLoadBalancerHTTPListenerAttribute - Server Load Balancer

Queries the configurations of an HTTP listener.

Operation description

A Classic Load Balancer (CLB) instance is created. For more information, see CreateLoadBalancer .
An HTTP listener is created. For more information about how to create an HTTP listener, see CreateLoadBalancerHTTPListener .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
slb:DescribeLoadBalancerHTTPListenerAttribute	get	loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the CLB instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
LoadBalancerId	string	Yes	The CLB instance ID.	lb-bp1uaunez0uho0zf0****
ListenerPort	integer	Yes	The frontend port that is used by the CLB instance. Valid values: 1 to 65535.	80

Response parameters

Parameter	Type	Description	Example
	object
AclType	string	The type of the ACL. Valid values: white: a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists apply to scenarios where you want to allow only specific IP addresses to access an application. Your service may be adversely affected if the whitelist is not properly configured. If a whitelist is configured, only requests from IP addresses that are added to the whitelist are forwarded by the listener. If you enable a whitelist but do not add an IP address to the ACL, the listener forwards all requests. black: a blacklist. All requests from the IP addresses or CIDR blocks in the network ACL are rejected. Blacklists apply to scenarios where you want to block access from specified IP addresses to an application. If a blacklist is configured for a listener but no IP address is added to the blacklist, the listener forwards all requests. Note This parameter is required when AclStatus is set to on.	white
VServerGroupId	string	The ID of the associated server group.	rsp-cige6j****
Status	string	The status of the listener. Valid values: running stopped	stopped
XForwardedFor_ClientSrcPort	string	Indicates whether the `XForwardedFor_ClientSrcPort` header is used to retrieve the client port. Valid values: on off	off
Cookie	string	The cookie that is configured on the server.	B490B5EBF6F3CD402E515D22BCDA1598
Gzip	string	Indicates whether `Gzip` compression is enabled to compress specific types of files. Valid values: on off	on
HealthCheckConnectPort	integer	The port that is used for health checks. Note This parameter takes effect only when HealthCheck is set to on.	8080
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710
Description	string	The name of the listener.	test
Bandwidth	integer	The maximum bandwidth of the listener. Unit: Mbit/s. -1: If -1 is returned, it indicates that the bandwidth of the listener is unlimited. 1 to 5120: If a value from 1 to 5120 is returned, the value indicates the maximum bandwidth of the listener. The sum of the maximum bandwidth of all listeners added to a CLB instance does not exceed the maximum bandwidth of the CLB instance.	-1
HealthCheckTimeout	integer	The timeout period of each health check. Unit: seconds.	3
AclStatus	string	Indicates whether access control is enabled. Valid values: on off	off
BackendServerPort	integer	The backend port that is used by the CLB instance.	80
CookieTimeout	integer	The timeout period of a cookie. Unit: seconds.	500
HealthCheckDomain	string	The domain name that you want to use for health checks.	www.domain.com
UnhealthyThreshold	integer	The unhealthy threshold.	4
ForwardPort	integer	The listener port that is used to redirect HTTP requests to HTTPS. Note If the ListenerForward parameter is set to off, this parameter is not displayed.	80
XForwardedFor_SLBID	string	Indicates whether the `SLB-ID` header is used to retrieve the ID of the CLB instance. Valid values: on off	on
SecurityStatus	string	Indicates whether the listener is in the Secure state. Valid values: on off	on
HealthCheckHttpCode	string	The HTTP status code for a successful health check.	http_2xx,http_3xx
ListenerForward	string	Indicates whether HTTP-to-HTTPS redirection is enabled. Valid values: on off	on
XForwardedFor	string	Indicates whether the `X-Forwarded-For` header is used to preserve the real IP address of the client. Valid values: on off	on
IdleTimeout	integer	The timeout period of an idle connection. Unit: seconds. Default value: 15. Valid values: 1 to 60. If no request is received within the specified timeout period, CLB closes the connection. When a request is received, CLB establishes a new connection.	2
RequestTimeout	integer	The timeout period of a request. Unit: seconds. Default value: 60. Valid values: 1 to 180. If no response is received from a backend server within the specified timeout period, CLB returns the HTTP 504 status code to the client.	34
ListenerPort	integer	The frontend port that is used by the CLB instance.	80
HealthCheckInterval	integer	The interval at which health checks are performed. Unit: seconds.	5
XForwardedFor_SLBPORT	string	Indicates whether the `XForwardedFor_SLBPORT` header is used to retrieve the listener port of the CLB instance. Valid values: on off	off
HealthCheckURI	string	The URL path that is used for health checks. The URI must be 1 to 80 characters in length, and can contain only digits, letters, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URI must start with a forward slash (/) but cannot be a single forward slash (/).	/test/index.html
StickySessionType	string	The method that is used to handle a cookie. Valid values: insert and server. insert: inserts a cookie. CLB inserts a session cookie (SERVERID) into the first HTTP or HTTPS response that is sent to a client. Subsequent requests to CLB carry this cookie, and CLB determines the destination servers of the requests based on the cookies. server: rewrites a cookie. When CLB detects a user-defined cookie, it overwrites the original cookie with the user-defined cookie. The next request from the client carries the user-defined cookie, and the listener forwards this request to the recorded backend server. Note This parameter is required when StickySession is set to on.	insert
AclId	string	The ID of the network ACL that is associated with a listener. Note This parameter is returned when AclStatus is set to on.	on
Scheduler	string	The routing algorithm. Valid values: wrr: Backend servers that have higher weights receive more requests than backend servers that have lower weights. rr: Requests are sequentially distributed to backend servers.	wrr
HealthyThreshold	integer	The healthy threshold.	4
XForwardedFor_proto	string	Indicates whether the `X-Forwarded-Proto` header is used to retrieve the listener protocol. Valid values: on off	on
XForwardedFor_SLBIP	string	Indicates whether the `SLB-IP` header is used to retrieve the virtual IP address requested by the client. Valid values: on off	on
StickySession	string	Indicates whether session persistence is enabled. Valid values: on off	on
HealthCheckMethod	string	The health check method used by HTTP listeners. Valid values: head and get. Note This parameter is returned when HealthCheck is set to on.	get
HealthCheck	string	Indicates whether the health check feature is enabled. Valid values: on off	on
Rules	array<object>	The list of forwarding rules.
	object
VServerGroupId	string	The ID of the server group specified in the forwarding rule.	123
Url	string	The request URL.	/example
Domain	string	The domain name.	www.example.com
RuleName	string	The name of the forwarding rule.	test
RuleId	string	The ID of the forwarding rule.	1234
LoadBalancerId	string	The CLB instance ID.	lb-bp1uaunez0uho0zf0****
Tags	array<object>	The tags.
	object
TagKey	string	The key of tag N. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 64 characters in length. The key cannot start with `acs:` or `aliyun` or contain `http://` or `https://`.	TestKey
TagValue	string	The value of tag N. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value must be 0 to 128 characters in length, and cannot start with `acs:`. It cannot contain `http://` or `https://`.	TestValue

Examples

Sample success responses

JSONformat

{
  "AclType": "white",
  "VServerGroupId": "rsp-cige6j****",
  "Status": "stopped",
  "XForwardedFor_ClientSrcPort": "off",
  "Cookie": "B490B5EBF6F3CD402E515D22BCDA1598",
  "Gzip": "on",
  "HealthCheckConnectPort": 8080,
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "Description": "test",
  "Bandwidth": -1,
  "HealthCheckTimeout": 3,
  "AclStatus": "off",
  "BackendServerPort": 80,
  "CookieTimeout": 500,
  "HealthCheckDomain": "www.domain.com",
  "UnhealthyThreshold": 4,
  "ForwardPort": 80,
  "XForwardedFor_SLBID": "on",
  "SecurityStatus": "on",
  "HealthCheckHttpCode": "http_2xx,http_3xx",
  "ListenerForward": "on",
  "XForwardedFor": "on",
  "IdleTimeout": 2,
  "RequestTimeout": 34,
  "ListenerPort": 80,
  "HealthCheckInterval": 5,
  "XForwardedFor_SLBPORT": "off",
  "HealthCheckURI": "/test/index.html",
  "StickySessionType": "insert ",
  "AclId": "on",
  "Scheduler": "wrr",
  "HealthyThreshold": 4,
  "XForwardedFor_proto": "on",
  "XForwardedFor_SLBIP": "on",
  "StickySession": "on",
  "HealthCheckMethod": "get",
  "HealthCheck": "on",
  "Rules": {
    "Rule": [
      {
        "VServerGroupId": "123",
        "Url": "/example",
        "Domain": "www.example.com",
        "RuleName": "test",
        "RuleId": "1234"
      }
    ]
  },
  "LoadBalancerId": "lb-bp1uaunez0uho0zf0****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-05-28	The response structure of the API has changed	View Change Details
2023-12-14	The response structure of the API has changed	View Change Details