DescribeLoadBalancerListeners - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the listeners of a Classic Load Balancer (CLB) instance.

Operation description

A CLB instance is created. For more information, see CreateLoadBalancer .
One or more listeners are added to the CLB instance. For more information, see the following topics:

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:DescribeLoadBalancerListeners	Read	LoadBalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the CLB instance is deployed. You can call the DescribeRegions operation to query the most recent region list. Note If the endpoint of the selected region is slb.aliyuncs.com, the `RegionId` parameter is required.	cn-hangzhou
NextToken	string	No	The token that is used for the next query. Valid values: If this is your first query and no subsequent queries are to be sent, ignore this parameter. If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. If you do not specify this parameter, the default value 20 is used.	50
ListenerProtocol	string	No	The protocol used by the listener. Valid values: tcp udp http https	http
LoadBalancerId	array	No	The ID of the CLB instance. You can specify at most 10 IDs.
	string	No	The ID of the CLB instance. You can specify at most 10 IDs.	LoadBalancerId.1=lb-uf6so8u4g35prnvsw**,LoadBalancerId.2=lb-uf6s1l1kukqv4u5nt**
Tag	object []	No	The tags.
Key	string	No	The key of the tag. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key must be 1 to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	TestKey
Value	string	No	The tag value. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag value cannot contain `http://` or `https://`.	TestValue
ListenerPort	integer	No	The frontend port that is used by the CLB instance.	443
Description	string	No	The description of the listener.	HTTPS_443

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	The token that determines the start point of the query. Valid values: If NextToken is empty, it indicates that no subsequent query is to be sent. If a value is returned for NextToken, the value is the token that determines the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The ID of the request.	365F4154-92F6-4AE4-92F8-7FF34B540710
TotalCount	integer	The total number of entries returned.	10
MaxResults	integer	The number of entries returned per page.	50
Listeners	object []	The list of listeners on the CLB instance. Note This parameter is not returned if no listener is created on the CLB instance.
AclType	string	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 you enable a whitelist but do not add an IP address 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. A blacklist applies to scenarios in which you want to deny access from specific IP addresses. If a blacklist is configured for a listener but no IP address is added to the blacklist, the listener forwards all requests.	white
Status	string	The status of the listener. Valid values: running: The listener runs as expected. stopped: The listener is disabled.	running
VServerGroupId	string	The ID of the vServer group that is associated with the listener.	rsp-cige6j****
ListenerProtocol	string	The protocol used by the listener.	http
LoadBalancerId	string	The ID of the CLB instance.	lb-bp1b6c719dfa****
ListenerPort	integer	The listening port.	80
AclId	string	The ID of the network ACL.	nacl-a2do9e413e0spzasx****
Scheduler	string	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.	wrr
Bandwidth	integer	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.	-1
Description	string	The description of the listener.	test
AclStatus	string	Indicates whether access control is enabled. Valid values: on: yes off: no	off
BackendServerPort	integer	The port of the backend server. Note This parameter takes effect when the `VServerGroupId` parameter and the `MasterSlaveServerGroupId` parameter are empty.	80
HTTPListenerConfig	object	The configuration of the HTTP listener.
HealthCheckHttpVersion	string	The HTTP version that is used for health checks.	HTTP 1.0
XForwardedFor_ClientSrcPort	string	Indicates whether the `XForwardedFor_ClientSrcPort` header is used to retrieve the client port. Valid values: on: yes off: no	on
Cookie	string	The cookie that is configured on the server.	B490B5EBF6F3CD402E515D22BCDA****
Gzip	string	Indicates whether Gzip compression is enabled. Valid values: on: yes off: no	on
HealthCheckConnectPort	integer	The port that is used for health checks. Note This parameter takes effect when the HealthCheck parameter is set to on.	8080
HealthCheckTimeout	integer	The maximum timeout period of a health check. Unit: seconds.	3
HealthCheckType	string	The protocol that is used for health checks.	tcp
CookieTimeout	integer	The timeout period of a cookie. Unit: seconds. Valid values: 1 to 86400.	500
HealthCheckDomain	string	The domain name that is used for health checks.	www.example.com
UnhealthyThreshold	integer	The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status is changed from success to fail. Valid values: 2 to 10.	4
XForwardedFor_SLBID	string	Indicates whether the `SLB-ID` header is used to retrieve the ID of the CLB instance. Valid values: on: yes off: no	on
ForwardPort	integer	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 displayed.	80
HealthCheckHttpCode	string	The HTTP status codes that are used to determine whether the backend server passes the health check.	http_2xx,http_3xx
ListenerForward	string	Indicates whether HTTP-to-HTTPS redirection is enabled. Valid values: on: yes off: no	on
XForwardedFor	string	Indicates whether the `XForwardedFor` header is used to retrieve client IP addresses. Valid values: on: yes off: no	on
IdleTimeout	integer	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 a request is received, CLB establishes a new connection.	15
RequestTimeout	integer	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 the `HTTP 504` status code to the client.	60
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 listening port. Valid values: on: yes off: no	on
HealthCheckURI	string	The URI that is used for health checks.	/test/index.html
StickySessionType	string	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 will distribute the request to the recorded backend server.	insert
HealthyThreshold	integer	The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status is changed from fail to success. Valid values: 2 to 10.	4
XForwardedFor_proto	string	Indicates whether the `X-Forwarded-Proto` header is used to retrieve the listening protocol. Valid values: on: yes off: no	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: yes off: no	on
StickySession	string	Indicates whether session persistence is enabled. Valid values: on: yes off: no	on
HealthCheckMethod	string	The health check method. Valid values: head and get.	get
HealthCheck	string	Indicates whether the health check feature is enabled. Valid values: on: yes off: no	on
HTTPSListenerConfig	object	The configuration of the HTTPS listener.
XForwardedFor_ClientCertClientVerify	string	Indicates whether the `XForwardedFor_ClientCertClientVerify` header is used to retrieve the verification result of the client certificate. Valid values: on: yes off: no	off
HealthCheckHttpVersion	string	The HTTP version that is used for health checks.	HTTP 1.0
XForwardedFor_ClientSrcPort	string	Indicates whether the `XForwardedFor_ClientSrcPort` header is used to retrieve the client port. Valid values: on: yes off: no	off
Cookie	string	The cookie that is configured on the server.	B490B5EBF6F3CD402E515D22BCDA****
Gzip	string	Indicates whether Gzip compression is enabled. Valid values: on: yes off: no	on
EnableHttp2	string	Indicates whether `HTTP 2.0` is enabled. Valid values: on: yes off: no	off
CACertificateId	string	The ID of the certificate authority (CA) certificate.	idkp-234-cn-test-0****
HealthCheckConnectPort	integer	The port that is used for health checks.	8080
HealthCheckTimeout	integer	The maximum timeout period of a health check. Unit: seconds.	3
HealthCheckType	string	The protocol that is used for health checks.	tcp
CookieTimeout	integer	The timeout period of a cookie. Unit: seconds. Valid values: 1 to 86400.	500
HealthCheckDomain	string	The domain name that is used for health checks.	www.example.com
UnhealthyThreshold	integer	The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status is changed from success to fail. Valid values: 2 to 10.	4
XForwardedFor_SLBID	string	Indicates whether the `SLB-ID` header is used to retrieve the ID of the CLB instance. Valid values: on: yes off: no	on
XForwardedFor_ClientCertSubjectDN	string	Indicates whether the `XForwardedFor_ClientCertSubjectDN` header is used to retrieve information about the owner of the client certificate. Valid values: on: yes off: no	off
HealthCheckHttpCode	string	The HTTP status codes that are used to determine whether the backend server passes the health check.	http_2xx,http_3xx
XForwardedFor_ClientCertFingerprint	string	Indicates whether the `XForwardedFor_ClientCertFingerprint` header is used to retrieve the fingerprint of the client certificate. Valid values: on: yes off: no	off
XForwardedFor	string	Indicates whether the `XForwardedFor` header is used to retrieve client IP addresses. Valid values: on: yes off: no	on
RequestTimeout	integer	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 the `HTTP 504` status code to the client.	60
IdleTimeout	integer	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 a request is received, CLB establishes a new connection.	15
ServerCertificateId	string	The ID of the server certificate.	idkp-123-cn-test-0****
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 listening port. Valid values: on: yes off: no	off
HealthCheckURI	string	The URI that is used for health checks.	/test/index.html
StickySessionType	string	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 will distribute the request to the recorded backend server.	insert
XForwardedFor_ClientCertIssuerDN	string	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	off
HealthyThreshold	integer	The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status is changed from fail to success. Valid values: 2 to 10.	4
XForwardedFor_proto	string	Indicates whether the `X-Forwarded-Proto` header is used to retrieve the listening protocol. Valid values: on: yes off: no	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: yes off: no	on
StickySession	string	Indicates whether session persistence is enabled. Valid values: on: yes off: no	on
HealthCheckMethod	string	The health check method.	get
TLSCipherPolicy	string	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	tls_cipher_policy_1_0
HealthCheck	string	Indicates whether the health check feature is enabled. Valid values: on: yes off: no	on
TCPListenerConfig	object	The configuration of the TCP listener.
HealthCheckHttpCode	string	The HTTP status codes that are used to determine whether the backend server passes the health check.	http_2xx,http_3xx
ConnectionDrainTimeout	integer	The timeout period of connection draining. Unit: seconds. Value values: 10 to 900.	300
PersistenceTimeout	integer	Indicates whether session persistence is enabled. Unit: seconds. Valid values: 0 to 3600. 0 indicates that session persistence is disabled.	0
HealthCheckInterval	integer	The interval between two consecutive health checks. Unit: seconds.	5
HealthCheckURI	string	The URI that is used for health checks.	/test/index.html
HealthCheckConnectPort	integer	The port that is used for health checks.	8080
EstablishedTimeout	integer	The timeout period of a connection. Unit: seconds.	500
HealthCheckType	string	The protocol that is used for health checks.	tcp
HealthCheckConnectTimeout	integer	The timeout period of health checks. Unit: seconds. Valid values: 1 to 300.	100
MasterSlaveServerGroupId	string	The ID of the primary/secondary server group that is associated with the listener.	rsp-0bfucw*****
HealthyThreshold	integer	The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status is changed from fail to success. Valid values: 2 to 10.	4
HealthCheckDomain	string	The domain name that is used for health checks.	www.example.com
UnhealthyThreshold	integer	The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status is changed from success to fail. Valid values: 2 to 10.	4
ConnectionDrain	string	Indicates whether connection draining is enabled. Valid values: on: yes off: no	off
HealthCheckMethod	string	The health check method.	get
HealthCheck	string	Indicates whether the health check feature is enabled. Valid values: on: yes off: no	on
ProxyProtocolV2Enabled	string	Indicates whether the Proxy protocol is used to pass client IP addresses to backend servers. Valid values: true: yes false: no	false
UDPListenerConfig	object	The configuration of the UDP listener.
ConnectionDrainTimeout	integer	The timeout period of connection draining. Unit: seconds. Value values: 10 to 900.	300
HealthCheckInterval	integer	The interval between two consecutive health checks. Unit: seconds.	5
HealthCheckExp	string	The response string for UDP listener health checks.	ok
HealthCheckConnectPort	integer	The port that is used for health checks.	8080
HealthCheckConnectTimeout	integer	The timeout period for a health check response.	100
MasterSlaveServerGroupId	string	The ID of the primary/secondary server group that is associated with the listener.	rsp-0bfucw****
HealthyThreshold	integer	The number of times that a backend server must consecutively pass health checks before it is declared healthy.	4
UnhealthyThreshold	integer	The number of times that a backend server must consecutively fail health checks before it is declared unhealthy.	4
ConnectionDrain	string	Indicates whether connection draining is enabled. Valid values: on: yes off: no	off
HealthCheckReq	string	The request string for UDP listener health checks.	hello
HealthCheck	string	Indicates whether the health check feature is enabled. Valid values: on: yes off: no	on
ProxyProtocolV2Enabled	string	Indicates whether the Proxy protocol is used to pass client IP addresses to backend servers. Valid values: true: yes false: no	false
Tags	object []	The tags.
TagValue	string	The tag value. For more information about how to obtain a tag value, see DescribeTagKeyList .	TestValue
TagKey	string	The tag key.	TestKey

Examples

Sample success responses

JSONformat

{
  "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": 80,
      "AclId": "nacl-a2do9e413e0spzasx****",
      "Scheduler": "wrr",
      "Bandwidth": -1,
      "Description": "test",
      "AclStatus": "off",
      "BackendServerPort": 80,
      "HTTPListenerConfig": {
        "HealthCheckHttpVersion": "HTTP 1.0",
        "XForwardedFor_ClientSrcPort": "on",
        "Cookie": "B490B5EBF6F3CD402E515D22BCDA****",
        "Gzip": "on",
        "HealthCheckConnectPort": 8080,
        "HealthCheckTimeout": 3,
        "HealthCheckType": "tcp",
        "CookieTimeout": 500,
        "HealthCheckDomain": "www.example.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.example.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.example.com",
        "UnhealthyThreshold": 4,
        "ConnectionDrain": "off",
        "HealthCheckMethod": "get",
        "HealthCheck": "on",
        "ProxyProtocolV2Enabled": "false"
      },
      "UDPListenerConfig": {
        "ConnectionDrainTimeout": 300,
        "HealthCheckInterval": 5,
        "HealthCheckExp": "ok",
        "HealthCheckConnectPort": 8080,
        "HealthCheckConnectTimeout": 100,
        "MasterSlaveServerGroupId": "rsp-0bfucw****",
        "HealthyThreshold": 4,
        "UnhealthyThreshold": 4,
        "ConnectionDrain": "off",
        "HealthCheckReq": "hello",
        "HealthCheck": "on",
        "ProxyProtocolV2Enabled": "false"
      },
      "Tags": [
        {
          "TagValue": "TestValue",
          "TagKey": "TestKey"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	IllegalParam.ListenerProtocol	The param of ListenerProtocol is illegal.
400	IllegalParam.MaxResults	The param of MaxResults is illegal.
400	IllegalParam.NextToken	The param of NextToken is illegal.
400	IllegalParamSize.LoadBalancerId	The param size of LoadBalancerId is illegal.
400	MissingParam.TagKey	The param of TagKey is missing.

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

Change history

Change time

Summary of changes

Operation

2023-10-25

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: ListenerPort
	Added Input Parameters: Description

2023-07-04

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400