DescribeLoadBalancerHTTPSListenerAttribute

Last Updated: May 22, 2017

Description

Queries HTTPS Listener information.Listeners have 5 statuses: starting, running, configuring, stopping, and stopped. For the listener status transition chart and descriptions of each status, refer to the appendixServer Load Balancer Listener Status Transition Chart

Request Parameters

Name Type Required? Description
Action String Yes Operator interface name, required parameter. Value:DescribeLoadBalancerHTTPSListenerAttribute
LoadBalancerId String Yes Unique ID of an Server Load Balancer instance.
ListenerPort Integer Yes Server Load Balancer instance’s frontend port. Values:1-65535

Return Parameters

Name Type Description
Public Return Parameters For details, see Public Parameters.
ListenerPort Integer Server Load Balancer instance’s frontend port.
BackendServerPort Integer Server Load Balancer instance’s backend port.
Bandwidth Integer Listener’s peak bandwidth.
Status String Current listener status. There are 5 statuses: starting, running, configuring, stopping, and stopped.
XForwardedFor String Whether or not the X-Forwarded-For method is enabled to retrieve visitors’ real IPs. On enables XForwardedFor and Off disables XForwardedFor. Note: For security considerations, this parameter is required to be set to On since May 15, 2015.
Scheduler String Scheduling algorithm. wrr or wlc.
StickySession String Whether or not session persistence is enabled. On enables session persistence and Off disables session persistence.
StickySessionType String Cookie processing method. When set to insert, this indicates it is inserted by the Server Load Balancer. When set to server, this indicates the Server Load Balancer learns from the backend server.
CookieTimeout Integer Cookie timeout time.
Cookie String Server’s cookie configuration. Only effective when Type is set to server.
HealthCheck String Whether or not health checks are enabled. On enables health checks and Off disables them.
HealthCheckDomain String Health check domain name.
HealthCheckURI String Health check URI.
HealthyThreshold Integer Number of successive successful health checks to change the backend server’s status from Fail to Success.
UnhealthyThreshold Integer Number of successive failed health checks to change the backend server’s status from Success to Fail.
HealthCheckTimeout Integer Maximum timeout time for each health check response, in seconds.
HealthCheckInterval Integer Interval between health checks, in seconds.
HealthCheckHttpCode String Normal health check HTTP status code.
HealthCheckConnectPort Integer Port used for health checks.
ServerCertificateId String Security certificate ID.
Gzip String Whether to open Gzip compression.

Example

Request Example

  1. https://slb.aliyuncs.com/
  2. &Action=DescribeLoadBalancerHTTPSListenerAttribute
  3. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  4. &ListenerPort=80443
  5. &<Public Request Parameters>

Return Example

  • XML format
    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeLoadBalancerHTTPSListenerAttributeResponse>
    3. <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4. <ListenerPort>80</ListenerPort>
    5. <BackendServerPort>80</BackendServerPort>
    6. <Bandwidth>-1</Bandwidth>
    7. <Status>stopped</Status>
    8. <Schedule>wrr</Schedule>
    9. <XForwardedFor>on</XForwardedFor>
    10. <ServerCertificateId>idkp-123-cn-test-01</ServerCertificateId>
    11. </DescribeLoadBalancerHTTPSListenerAttributeResponse>
  • JSON format
    1. {
    2. "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
    3. "ListenerPort":80,
    4. "BackendServerPort":80,
    5. "Bandwidth":-1,
    6. "Status":"stopped",
    7. "Schedule":"wrr",
    8. "XForwardedFor":"on",
    9. "ServerCertificateId":"idkp-123-cn-test-01"
    10. }
Thank you! We've received your feedback.