GetListenersSlbListener

data class GetListenersSlbListener(val backendPort: Int, val bandwidth: Int, val caCertificateId: String, val cookie: String, val cookieTimeout: Int, val description: String, val enableHttp2: String, val establishedTimeout: Int, val frontendPort: Int, val gzip: String, val healthCheck: String, val healthCheckConnectPort: Int, val healthCheckConnectTimeout: Int, val healthCheckDomain: String, val healthCheckHttpCode: String, val healthCheckInterval: Int, val healthCheckTimeout: Int, val healthCheckType: String, val healthCheckUri: String, val healthyThreshold: Int, val idleTimeout: Int, val masterSlaveServerGroupId: String, val persistenceTimeout: Int, val protocol: String, val proxyProtocolV2Enabled: Boolean, val requestTimeout: Int, val scheduler: String, val securityStatus: String, val serverCertificateId: String, val serverGroupId: String, val sslCertificateId: String, val status: String, val stickySession: String, val stickySessionType: String, val tlsCipherPolicy: String, val unhealthyThreshold: Int, val xForwardedFor: String, val xForwardedForSlbId: String, val xForwardedForSlbIp: String, val xForwardedForSlbProto: String)

Constructors

Link copied to clipboard
constructor(backendPort: Int, bandwidth: Int, caCertificateId: String, cookie: String, cookieTimeout: Int, description: String, enableHttp2: String, establishedTimeout: Int, frontendPort: Int, gzip: String, healthCheck: String, healthCheckConnectPort: Int, healthCheckConnectTimeout: Int, healthCheckDomain: String, healthCheckHttpCode: String, healthCheckInterval: Int, healthCheckTimeout: Int, healthCheckType: String, healthCheckUri: String, healthyThreshold: Int, idleTimeout: Int, masterSlaveServerGroupId: String, persistenceTimeout: Int, protocol: String, proxyProtocolV2Enabled: Boolean, requestTimeout: Int, scheduler: String, securityStatus: String, serverCertificateId: String, serverGroupId: String, sslCertificateId: String, status: String, stickySession: String, stickySessionType: String, tlsCipherPolicy: String, unhealthyThreshold: Int, xForwardedFor: String, xForwardedForSlbId: String, xForwardedForSlbIp: String, xForwardedForSlbProto: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Port opened on the backend server to receive requests.

Link copied to clipboard

Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.

Link copied to clipboard

ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.

Link copied to clipboard

Cookie configured by the backend server. Only available when the sticky_session_type is server.

Link copied to clipboard

Cookie timeout in seconds. Only available when the sticky_session_type is insert.

Link copied to clipboard

The description of slb listener.

Link copied to clipboard

Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.

Link copied to clipboard

Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.

Link copied to clipboard

Filter listeners by the specified frontend port.

Link copied to clipboard

Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.

Link copied to clipboard

Indicate whether health check is enabled of not. Possible values are on and off.

Link copied to clipboard

Port used for health check.

Link copied to clipboard

Amount of time in seconds to wait for the response for a health check.

Link copied to clipboard

Domain name used for health check. The SLB sends HTTP head requests to the backend server, the domain is useful when the backend server verifies the host field in the requests. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).

Link copied to clipboard

HTTP status codes indicating that the health check is normal. It can contain several comma-separated values such as "http_2xx,http_3xx". Only available when the protocol is http, https or tcp (in this case health_check_type must be http).

Link copied to clipboard

Time interval between two consecutive health checks.

Link copied to clipboard

Amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails. Only available when the protocol is http or https.

Link copied to clipboard

Health check method. Possible values are tcp and http. Only available when the protocol is tcp.

Link copied to clipboard

URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).

Link copied to clipboard

Number of consecutive successes of health check performed on the same ECS instance (from failure to success).

Link copied to clipboard

Timeout of http or https listener established connection idle timeout. Valid value range: 1-60 in seconds. Default to 15.

Link copied to clipboard

ID of the active/standby server group.

Link copied to clipboard

Timeout value of the TCP connection in seconds. If the value is 0, the session persistence function is disabled. Only available when the protocol is tcp.

Link copied to clipboard

Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

Link copied to clipboard

Whether to support carrying the client source address to the backend server through the Proxy Protocol. Valid values are true and false. Default to false.

Link copied to clipboard

Timeout of http or https listener request (which does not get response from backend) timeout. Valid value range: 1-180 in seconds. Default to 60.

Link copied to clipboard

Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).

Link copied to clipboard

Security status. Only available when the protocol is https.

Link copied to clipboard
Link copied to clipboard

ID of the linked VServer group.

Link copied to clipboard

ID of the server certificate. Only available when the protocol is https.

Link copied to clipboard

Listener status.

Link copied to clipboard

Indicate whether session persistence is enabled or not. If enabled, all session requests from the same client are sent to the same backend server. Possible values are on and off. Only available when the protocol is http or https.

Link copied to clipboard

Method used to handle the cookie. Possible values are insert (cookie added to the response) and server (cookie set by the backend server). Only available when the protocol is http or https and sticky_session is on.

Link copied to clipboard

Https listener TLS cipher policy. Valid values are tls_cipher_policy_1_0, tls_cipher_policy_1_1, tls_cipher_policy_1_2, tls_cipher_policy_1_2_strict. Default to tls_cipher_policy_1_0.

Link copied to clipboard

Number of consecutive failures of health check performed on the same ECS instance (from success to failure).

Link copied to clipboard

Indicate whether the HTTP header field "X-Forwarded-For" is added or not; it allows the backend server to know about the user's IP address. Possible values are on and off. Only available when the protocol is http or https.

Link copied to clipboard

Indicate whether the HTTP header field "X-Forwarded-For_SLBID" is added or not; it allows the backend server to know about the SLB ID. Possible values are on and off. Only available when the protocol is http or https.

Link copied to clipboard

Indicate whether the HTTP header field "X-Forwarded-For_SLBIP" is added or not; it allows the backend server to know about the SLB IP address. Possible values are on and off. Only available when the protocol is http or https.

Link copied to clipboard

Indicate whether the HTTP header field "X-Forwarded-For_proto" is added or not; it allows the backend server to know about the user's protocol. Possible values are on and off. Only available when the protocol is http or https.