Queries listeners of Classic Load Balancer (CLB) instances.

Prerequisites

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String No cn-hangzhou

The ID of the region where the CLB instance is created.

You can call the DescribeRegions operation to query the most recent region list.

Action String Yes DescribeLoadBalancerListeners

The operation that you want to perform. Set the value to DescribeLoadBalancerListeners.

NextToken String No FFmyTO70tTpLG6I3FmYAXGKPd****

The token that is used for the next query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
MaxResults Integer No 50

The maximum number of entries to return.

Valid value: 1 to 100. If you do not set this parameter, the system returns at most 20 entries.

ListenerProtocol String No http

The listening protocol. Valid values:

  • tcp
  • udp
  • http
  • https

Response parameters

Parameter Type Example Description
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

The token that is used for the next query. Valid values:

  • If NextToken is empty, it indicates that no next query is to be sent.
  • If a value of NextToken is returned, the value is the token that is used for the next query.
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

The ID of the request.

TotalCount Integer 10

The total number of entries returned.

MaxResults Integer 50

The maximum number of entries returned.

Listeners Array of Listener

The list of listeners returned.

AclType String white

The type of the network access control list (ACL). Valid values:

  • white: a whitelist. Only requests from the IP addresses or CIDR blocks in the network ACL are forwarded. Whitelists apply to scenarios in which 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. After a whitelist is configured, only requests from IP addresses that are added to the whitelist are forwarded by the listener.

    If a whitelist is configured but no IP address is added to the whitelist, the listener forwards all requests.

  • black: a blacklist. All requests from the IP addresses or CIDR blocks in the network ACL are denied. The blacklist applies to scenarios in which you want to deny access from specific IP addresses to an application.

    If a blacklist is configured but no IP address is added to the blacklist, the listener forwards all requests.

Status String running

The status of the listener. Valid values:

  • running: The listener runs as expected.
  • stopped: The listener is disabled.
VServerGroupId String rsp-cige6j****

The ID of the vServer group that is associated with the listener.

ListenerProtocol String http

The listening protocol.

LoadBalancerId String lb-bp1b6c719dfa****

The ID of the CLB instance.

ListenerPort Integer 123

The listening port.

AclId String nacl-a2do9e413e0spzasx****

The ID of the network ACL.

Scheduler String wrr

The scheduling algorithm. Valid values:

  • wrr: Backend servers with higher weights receive more requests than those with lower weights.
  • rr: Requests are distributed to backend servers in sequence.
Bandwidth Integer -1

The maximum bandwidth of the listener. Unit: Mbit/s. Valid values:

  • -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.
Description String test

The description of the listener.

AclStatus String off

Indicates whether access control is enabled. Valid values:

  • on: yes
  • off: no
BackendServerPort Integer 80

The port of the backend server.

Note This parameter takes effect only when the VServerGroupId and MasterSlaveServerGroupId parameters are both empty.
HTTPListenerConfig Object

The configuration of the HTTP listener.

HealthCheckHttpVersion String HTTP 1.0

The HTTP version that is used for health checks.

XForwardedFor_ClientSrcPort String on

Indicates whether the XForwardedFor_ClientSrcPort header is used to retrieve the client port. Valid values:

  • on: yes
  • off: no
Cookie String B490B5EBF6F3CD402E515D22BCDA****

The cookie that is configured on the backend server.

Gzip String on

Indicates whether Gzip compression is enabled. Valid values:

  • on: yes
  • off: no
HealthCheckConnectPort Integer 8080

The port that is used for health checks.

Note This parameter takes effect only when the HealthCheck parameter is set to on.
HealthCheckTimeout Integer 3

The timeout period of a health check. Unit: seconds.

HealthCheckType String tcp

The protocol that is used for health checks.

CookieTimeout Integer 500

The timeout period of a cookie.

HealthCheckDomain String www.domain****.com

The domain name that is used for health checks.

UnhealthyThreshold Integer 4

The unhealthy threshold.

XForwardedFor_SLBID String on

Indicates whether the SLB-ID header is used to retrieve the ID of the CLB instance. Valid values:

  • on: yes
  • off: no
ForwardPort Integer 80

The listening port that is used to redirect HTTP requests to HTTPS.

Note If the ListenerForward parameter is set to off, this parameter is not returned.
HealthCheckHttpCode String http_2xx,http_3xx

The HTTP status code for a successful health check.

ListenerForward String on

Indicates whether HTTP-to-HTTPS redirection is enabled. Valid values:

  • on: yes
  • off: no
XForwardedFor String on

Indicates whether the X-Forwarded-For header is used to retrieve client IP addresses. Valid values:

  • on: yes
  • off: no
IdleTimeout Integer 15

The timeout period of an idle connection. Unit: seconds. Valid values: 1 to 60.

If no request is received within the specified timeout period, CLB closes the connection. When another request is received, CLB establishes a new connection.

RequestTimeout Integer 60

The timeout period of a request. Unit: seconds. Valid values: 1 to 180.

If no response is received from a backend server during the request timeout period, CLB sends an HTTP 504 error code to the client.

HealthCheckInterval Integer 5

The interval at which health checks are performed. Unit: seconds.

XForwardedFor_SLBPORT String on

Indicates whether the XForwardedFor_SLBPORT header is used to retrieve the listening port. Valid values:

  • on: yes
  • off: no
HealthCheckURI String /test/index.html

The URI that is used for health checks.

StickySessionType String insert

The method that is used to handle a cookie. Valid values:

  • insert: inserts a cookie. CLB inserts a cookie (SERVERID) into the first HTTP or HTTPS response that is sent to a client. The next request from the client contains this cookie, and the listener forwards this request to the recorded backend server.
  • 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.
HealthyThreshold Integer 4

The healthy threshold.

XForwardedFor_proto String on

Indicates whether the X-Forwarded-Proto header is used to retrieve the listening protocol. Valid values:

  • on: yes
  • off: no
XForwardedFor_SLBIP String on

Indicates whether the SLB-IP header is used to retrieve the virtual IP address requested by the client. Valid values:

  • on: yes
  • off: no
StickySession String on

Indicates whether session persistence is enabled. Valid values:

  • on: yes
  • off: no
HealthCheckMethod String get

The health check method.

HealthCheck String on

Indicates whether the health check feature is enabled. Valid values:

  • on: yes
  • off: no
HTTPSListenerConfig Object

The configuration of the HTTPS listener.

XForwardedFor_ClientCertClientVerify String off

Indicates whether the XForwardedFor_ClientCertClientVerify header is used to retrieve the verification result of the client certificate. Valid values:

  • on: yes
  • off: no
HealthCheckHttpVersion String HTTP 1.0

The HTTP version that is used for health checks.

XForwardedFor_ClientSrcPort String off

Indicates whether the XForwardedFor_ClientSrcPort header is used to retrieve the client port. Valid values:

  • on: yes
  • off: no
Cookie String B490B5EBF6F3CD402E515D22BCDA****

The cookie that is configured on the backend server.

Gzip String on

Indicates whether Gzip compression is enabled. Valid values:

  • on: yes
  • off: no
EnableHttp2 String off

Indicates whether HTTP 2.0 is enabled. Valid values:

  • on: yes
  • off: no
CACertificateId String idkp-234-cn-test-0****

The ID of the certification authority (CA) certificate.

HealthCheckConnectPort Integer 8080

The port that is used for health checks.

HealthCheckTimeout Integer 3

The timeout period of a health check response. Unit: seconds.

HealthCheckType String tcp

The protocol that is used for health checks.

CookieTimeout Integer 500

The timeout period of a cookie.

HealthCheckDomain String www.domain****.com

The domain name that is used for health checks.

UnhealthyThreshold Integer 4

The unhealthy threshold.

XForwardedFor_SLBID String on

Indicates whether the SLB-ID header is used to retrieve the ID of the CLB instance. Valid values:

  • on: yes
  • off: no
XForwardedFor_ClientCertSubjectDN String off

Indicates whether the XForwardedFor_ClientCertSubjectDN header is used to retrieve information about the owner of the client certificate. Valid values:

  • on: yes
  • off: no
HealthCheckHttpCode String http_2xx,http_3xx

The HTTP status code for a successful health check.

XForwardedFor_ClientCertFingerprint String off

Indicates whether the XForwardedFor_ClientCertFingerprint header is used to retrieve the fingerprint of the client certificate. Valid values:

  • on: yes
  • off: no
XForwardedFor String on

Indicates whether the X-Forwarded-For header is used to retrieve client IP addresses. Valid values:

  • on: yes
  • off: no
RequestTimeout Integer 60

The request timeout period. Unit: seconds. Valid values: 1 to 180.

If no response is received from a backend server during the request timeout period, CLB sends an HTTP 504 error code to the client.

IdleTimeout Integer 15

The timeout period of an idle connection. Unit: seconds. Valid values: 1 to 60.

If no request is received within the specified timeout period, CLB closes the connection. When another request is received, CLB establishes a new connection.

ServerCertificateId String idkp-123-cn-test-0****

The ID of the server certificate.

HealthCheckInterval Integer 5

The interval between two consecutive health checks. Unit: seconds.

XForwardedFor_SLBPORT String off

Indicates whether the XForwardedFor_SLBPORT header is used to retrieve the listening port. Valid values:

  • on: yes
  • off: no
HealthCheckURI String /test/index.html

The URI that is used for health checks.

StickySessionType String insert

The method that is used to handle a cookie.

  • insert: inserts a cookie. CLB inserts a cookie (SERVERID) into the first HTTP or HTTPS response that is sent to a client. The next request from the client contains this cookie, and the listener forwards this request to the recorded backend server.
  • 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.
XForwardedFor_ClientCertIssuerDN String off

Indicates whether the XForwardedFor_ClientCertIssuerDN header is used to retrieve information about the authority that issues the client certificate. Valid values:

  • on: yes
  • off: no
HealthyThreshold Integer 4

The healthy threshold.

XForwardedFor_proto String on

Indicates whether the X-Forwarded-Proto header is used to retrieve the listening protocol. Valid values:

  • on: yes
  • off: no
XForwardedFor_SLBIP String on

Indicates whether the SLB-IP header is used to retrieve the virtual IP address requested by the client. Valid values:

  • on: yes
  • off: no
StickySession String on

Indicates whether session persistence is enabled. Valid values:

  • on: yes
  • off: no
HealthCheckMethod String get

The health check method.

TLSCipherPolicy String tls_cipher_policy_1_0

The Transport Layer Security (TLS) security policy. Each security policy contains TLS protocol versions and cipher suites available for HTTPS.

  • tls_cipher_policy_1_0:

    Supported TLS versions: TLS 1.0, TLS 1.1, and TLS 1.2

    Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA

  • tls_cipher_policy_1_1:

    Supported TLS versions: TLS 1.1 and TLS 1.2

    Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA

  • tls_cipher_policy_1_2

    Supported TLS version: TLS 1.2

    Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA

  • tls_cipher_policy_1_2_strict

    Supported TLS version: TLS 1.2

    Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA

  • tls_cipher_policy_1_2_strict_with_1_3

    Supported TLS versions: TLS 1.2 and TLS 1.3

    Supported cipher suites: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA

HealthCheck String on

Indicates whether the health check feature is enabled. Valid values:

  • on: yes
  • off: no
TCPListenerConfig Object

The configuration of the TCP listener.

HealthCheckHttpCode String http_2xx,http_3xx

The HTTP status code for a successful health check.

ConnectionDrainTimeout Integer 300

The timeout period of connection draining. Unit: seconds.

Value values: 10 to 900.

PersistenceTimeout Integer 0

Indicates whether session persistence is enabled.

0 indicates that session persistence is disabled.

HealthCheckInterval Integer 5

The interval between two consecutive health checks. Unit: seconds.

HealthCheckURI String /test/index.html

The URI that is used for health checks.

HealthCheckConnectPort Integer 8080

The port that is used for health checks.

EstablishedTimeout Integer 500

The timeout period of a connection.

HealthCheckType String tcp

The protocol that is used for health checks.

HealthCheckConnectTimeout Integer 100

The timeout period of health checks.

MasterSlaveServerGroupId String rsp-0bfucw*****

The ID of the primary/secondary server group that is associated with the listener.

HealthyThreshold Integer 4

The healthy threshold.

HealthCheckDomain String www.domain****.com

The domain name that is used for health checks.

UnhealthyThreshold Integer 4

The unhealthy threshold.

ConnectionDrain String off

Indicates whether connection draining is enabled. Valid values:

  • on: yes
  • off: no
HealthCheckMethod String get

The health check method.

HealthCheck String on

Indicates whether the health check feature is enabled. Valid values:

  • on: yes
  • off: no
UDPListenerConfig Object

The configuration of the UDP listener.

ConnectionDrainTimeout Integer 300

The timeout period of connection draining. Unit: seconds.

Value values: 10 to 900.

HealthCheckInterval Integer 5

The interval between two consecutive health checks. Unit: seconds.

HealthCheckExp String ok

The response string for UDP listener health checks.

HealthCheckConnectPort Integer 8080

The port that is used for health checks.

HealthCheckConnectTimeout Integer 100

The timeout period for a health check response.

MasterSlaveServerGroupId String rsp-0bfucw****

The ID of the primary/secondary server group that is associated with the listener.

HealthyThreshold Integer 4

The healthy threshold.

UnhealthyThreshold Integer 4

The unhealthy threshold.

ConnectionDrain String off

Indicates whether connection draining is enabled. Valid values:

  • on: yes
  • off: no
HealthCheckReq String hello

The request string for UDP listener health checks.

HealthCheck String on

Indicates whether the health check feature is enabled. Valid values:

  • on: yes
  • off: no

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&Action=DescribeLoadBalancerListeners
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=50
&ListenerProtocol=http
&LoadBalancerId.1=lb-uf6so8u4g35prnvsw****
&LoadBalancerId.2=lb-uf6s1l1kukqv4u5nt****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLoadBalancerListenersResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <TotalCount>10</TotalCount>
    <MaxResults>50</MaxResults>
    <Listeners>
        <AclType>white</AclType>
        <Status>running</Status>
        <VServerGroupId>rsp-cige6j****</VServerGroupId>
        <ListenerProtocol>http</ListenerProtocol>
        <LoadBalancerId>lb-bp1b6c719dfa****</LoadBalancerId>
        <ListenerPort>123</ListenerPort>
        <AclId>nacl-a2do9e413e0spzasx****</AclId>
        <Scheduler>wrr</Scheduler>
        <Bandwidth>-1</Bandwidth>
        <Description>test</Description>
        <AclStatus>off</AclStatus>
        <BackendServerPort>80</BackendServerPort>
        <HTTPListenerConfig>
            <HealthCheckHttpVersion>HTTP 1.0</HealthCheckHttpVersion>
            <XForwardedFor_ClientSrcPort>on</XForwardedFor_ClientSrcPort>
            <Cookie>B490B5EBF6F3CD402E515D22BCDA****</Cookie>
            <Gzip>on</Gzip>
            <HealthCheckConnectPort>8080</HealthCheckConnectPort>
            <HealthCheckTimeout>3</HealthCheckTimeout>
            <HealthCheckType>tcp</HealthCheckType>
            <CookieTimeout>500</CookieTimeout>
            <HealthCheckDomain>www.domain****.com</HealthCheckDomain>
            <UnhealthyThreshold>4</UnhealthyThreshold>
            <XForwardedFor_SLBID>on</XForwardedFor_SLBID>
            <ForwardPort>80</ForwardPort>
            <HealthCheckHttpCode>http_2xx,http_3xx</HealthCheckHttpCode>
            <ListenerForward>on</ListenerForward>
            <XForwardedFor>on</XForwardedFor>
            <IdleTimeout>15</IdleTimeout>
            <RequestTimeout>60</RequestTimeout>
            <HealthCheckInterval>5</HealthCheckInterval>
            <XForwardedFor_SLBPORT>on</XForwardedFor_SLBPORT>
            <HealthCheckURI>/test/index.html</HealthCheckURI>
            <StickySessionType>insert</StickySessionType>
            <HealthyThreshold>4</HealthyThreshold>
            <XForwardedFor_proto>on</XForwardedFor_proto>
            <XForwardedFor_SLBIP>on</XForwardedFor_SLBIP>
            <StickySession>on</StickySession>
            <HealthCheckMethod>get</HealthCheckMethod>
            <HealthCheck>on</HealthCheck>
        </HTTPListenerConfig>
        <HTTPSListenerConfig>
            <XForwardedFor_ClientCertClientVerify>off</XForwardedFor_ClientCertClientVerify>
            <HealthCheckHttpVersion>HTTP 1.0</HealthCheckHttpVersion>
            <XForwardedFor_ClientSrcPort>off</XForwardedFor_ClientSrcPort>
            <Cookie>B490B5EBF6F3CD402E515D22BCDA****</Cookie>
            <Gzip>on</Gzip>
            <EnableHttp2>off</EnableHttp2>
            <CACertificateId>idkp-234-cn-test-0****</CACertificateId>
            <HealthCheckConnectPort>8080</HealthCheckConnectPort>
            <HealthCheckTimeout>3</HealthCheckTimeout>
            <HealthCheckType>tcp</HealthCheckType>
            <CookieTimeout>500</CookieTimeout>
            <HealthCheckDomain>www.domain****.com</HealthCheckDomain>
            <UnhealthyThreshold>4</UnhealthyThreshold>
            <XForwardedFor_SLBID>on</XForwardedFor_SLBID>
            <XForwardedFor_ClientCertSubjectDN>off</XForwardedFor_ClientCertSubjectDN>
            <HealthCheckHttpCode>http_2xx,http_3xx</HealthCheckHttpCode>
            <XForwardedFor_ClientCertFingerprint>off</XForwardedFor_ClientCertFingerprint>
            <XForwardedFor>on</XForwardedFor>
            <RequestTimeout>60</RequestTimeout>
            <IdleTimeout>15</IdleTimeout>
            <ServerCertificateId>idkp-123-cn-test-0****</ServerCertificateId>
            <HealthCheckInterval>5</HealthCheckInterval>
            <XForwardedFor_SLBPORT>off</XForwardedFor_SLBPORT>
            <HealthCheckURI>/test/index.html</HealthCheckURI>
            <StickySessionType>insert</StickySessionType>
            <XForwardedFor_ClientCertIssuerDN>off</XForwardedFor_ClientCertIssuerDN>
            <HealthyThreshold>4</HealthyThreshold>
            <XForwardedFor_proto>on</XForwardedFor_proto>
            <XForwardedFor_SLBIP>on</XForwardedFor_SLBIP>
            <StickySession>on</StickySession>
            <HealthCheckMethod>get</HealthCheckMethod>
            <TLSCipherPolicy>tls_cipher_policy_1_0</TLSCipherPolicy>
            <HealthCheck>on</HealthCheck>
        </HTTPSListenerConfig>
        <TCPListenerConfig>
            <HealthCheckHttpCode>http_2xx,http_3xx</HealthCheckHttpCode>
            <ConnectionDrainTimeout>300</ConnectionDrainTimeout>
            <PersistenceTimeout>0</PersistenceTimeout>
            <HealthCheckInterval>5</HealthCheckInterval>
            <HealthCheckURI>/test/index.html</HealthCheckURI>
            <HealthCheckConnectPort>8080</HealthCheckConnectPort>
            <EstablishedTimeout>500</EstablishedTimeout>
            <HealthCheckType>tcp</HealthCheckType>
            <HealthCheckConnectTimeout>100</HealthCheckConnectTimeout>
            <MasterSlaveServerGroupId>rsp-0bfucw*****</MasterSlaveServerGroupId>
            <HealthyThreshold>4</HealthyThreshold>
            <HealthCheckDomain>www.domain****.com</HealthCheckDomain>
            <UnhealthyThreshold>4</UnhealthyThreshold>
            <ConnectionDrain>off</ConnectionDrain>
            <HealthCheckMethod>get</HealthCheckMethod>
            <HealthCheck>on</HealthCheck>
            <PortRanges/>
        </TCPListenerConfig>
        <TCPSListenerConfig/>
        <UDPListenerConfig>
            <ConnectionDrainTimeout>300</ConnectionDrainTimeout>
            <HealthCheckInterval>5</HealthCheckInterval>
            <HealthCheckExp>ok</HealthCheckExp>
            <HealthCheckConnectPort>8080</HealthCheckConnectPort>
            <HealthCheckConnectTimeout>100</HealthCheckConnectTimeout>
            <MasterSlaveServerGroupId>rsp-0bfucw****</MasterSlaveServerGroupId>
            <HealthyThreshold>4</HealthyThreshold>
            <UnhealthyThreshold>4</UnhealthyThreshold>
            <ConnectionDrain>off</ConnectionDrain>
            <HealthCheckReq>hello</HealthCheckReq>
            <HealthCheck>on</HealthCheck>
            <PortRanges/>
        </UDPListenerConfig>
    </Listeners>
</DescribeLoadBalancerListenersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount" : 10,
  "MaxResults" : 50,
  "Listeners" : [ {
    "AclType" : "white",
    "Status" : "running",
    "VServerGroupId" : "rsp-cige6j****",
    "ListenerProtocol" : "http",
    "LoadBalancerId" : "lb-bp1b6c719dfa****",
    "ListenerPort" : 123,
    "AclId" : "nacl-a2do9e413e0spzasx****",
    "Scheduler" : "wrr",
    "Bandwidth" : -1,
    "Description" : "test",
    "AclStatus" : "off",
    "BackendServerPort" : 80,
    "AclIds" : [ ],
    "HTTPListenerConfig" : {
      "HealthCheckHttpVersion" : "HTTP 1.0",
      "XForwardedFor_ClientSrcPort" : "on",
      "Cookie" : "B490B5EBF6F3CD402E515D22BCDA****",
      "Gzip" : "on",
      "HealthCheckConnectPort" : 8080,
      "HealthCheckTimeout" : 3,
      "HealthCheckType" : "tcp",
      "CookieTimeout" : 500,
      "HealthCheckDomain" : "www.domain****.com",
      "UnhealthyThreshold" : 4,
      "XForwardedFor_SLBID" : "on",
      "ForwardPort" : 80,
      "HealthCheckHttpCode" : "http_2xx,http_3xx",
      "ListenerForward" : "on",
      "XForwardedFor" : "on",
      "IdleTimeout" : 15,
      "RequestTimeout" : 60,
      "HealthCheckInterval" : 5,
      "XForwardedFor_SLBPORT" : "on",
      "HealthCheckURI" : "/test/index.html",
      "StickySessionType" : "insert",
      "HealthyThreshold" : 4,
      "XForwardedFor_proto" : "on",
      "XForwardedFor_SLBIP" : "on",
      "StickySession" : "on",
      "HealthCheckMethod" : "get",
      "HealthCheck" : "on"
    },
    "HTTPSListenerConfig" : {
      "XForwardedFor_ClientCertClientVerify" : "off",
      "HealthCheckHttpVersion" : "HTTP 1.0",
      "XForwardedFor_ClientSrcPort" : "off",
      "Cookie" : "B490B5EBF6F3CD402E515D22BCDA****",
      "Gzip" : "on",
      "EnableHttp2" : "off",
      "CACertificateId" : "idkp-234-cn-test-0****",
      "HealthCheckConnectPort" : 8080,
      "HealthCheckTimeout" : 3,
      "HealthCheckType" : "tcp",
      "CookieTimeout" : 500,
      "HealthCheckDomain" : "www.domain****.com",
      "UnhealthyThreshold" : 4,
      "XForwardedFor_SLBID" : "on",
      "XForwardedFor_ClientCertSubjectDN" : "off",
      "HealthCheckHttpCode" : "http_2xx,http_3xx",
      "XForwardedFor_ClientCertFingerprint" : "off",
      "XForwardedFor" : "on",
      "RequestTimeout" : 60,
      "IdleTimeout" : 15,
      "ServerCertificateId" : "idkp-123-cn-test-0****",
      "HealthCheckInterval" : 5,
      "XForwardedFor_SLBPORT" : "off",
      "HealthCheckURI" : "/test/index.html",
      "StickySessionType" : "insert",
      "XForwardedFor_ClientCertIssuerDN" : "off",
      "HealthyThreshold" : 4,
      "XForwardedFor_proto" : "on",
      "XForwardedFor_SLBIP" : "on",
      "StickySession" : "on",
      "HealthCheckMethod" : "get",
      "TLSCipherPolicy" : "tls_cipher_policy_1_0",
      "HealthCheck" : "on"
    },
    "TCPListenerConfig" : {
      "HealthCheckHttpCode" : "http_2xx,http_3xx",
      "ConnectionDrainTimeout" : 300,
      "PersistenceTimeout" : 0,
      "HealthCheckInterval" : 5,
      "HealthCheckURI" : "/test/index.html",
      "HealthCheckConnectPort" : 8080,
      "EstablishedTimeout" : 500,
      "HealthCheckType" : "tcp",
      "HealthCheckConnectTimeout" : 100,
      "MasterSlaveServerGroupId" : "rsp-0bfucw*****",
      "HealthyThreshold" : 4,
      "HealthCheckDomain" : "www.domain****.com",
      "UnhealthyThreshold" : 4,
      "ConnectionDrain" : "off",
      "HealthCheckMethod" : "get",
      "HealthCheck" : "on",
      "PortRanges" : [ { } ]
    },
    "TCPSListenerConfig" : { },
    "UDPListenerConfig" : {
      "ConnectionDrainTimeout" : 300,
      "HealthCheckInterval" : 5,
      "HealthCheckExp" : "ok",
      "HealthCheckConnectPort" : 8080,
      "HealthCheckConnectTimeout" : 100,
      "MasterSlaveServerGroupId" : "rsp-0bfucw****",
      "HealthyThreshold" : 4,
      "UnhealthyThreshold" : 4,
      "ConnectionDrain" : "off",
      "HealthCheckReq" : "hello",
      "HealthCheck" : "on",
      "PortRanges" : [ { } ]
    }
  } ]
}

Error codes

HttpCode Error code Error message Description
400 IllegalParam.ListenerProtocol The param of ListenerProtocol is illegal. The error message returned because the ListenerProtocol parameter is set to an invalid value. Specify a valid value and try again.
400 IllegalParam.MaxResults The param of MaxResults is illegal. The error message returned because the MaxResults parameter is set to an invalid value. Specify a valid value and try again.
400 IllegalParam.NextToken The param of NextToken is illegal. The error message returned because the NextToken parameter is set to an invalid value. Specify a valid value and try again.
400 IllegalParamSize.LoadBalancerId The param size of LoadBalancerId is illegal. The error message returned because the LoadBalancerId parameter is set to an invalid value. Specify a valid value and try again.

For a list of error codes, visit the API Error Center.