GetListeners

This data source provides the listeners related to a server load balancer of the current Alibaba Cloud user.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var sampleDs = Output.Create(AliCloud.Slb.GetListeners.InvokeAsync(new AliCloud.Slb.GetListenersArgs
        {
            LoadBalancerId = alicloud_slb.Sample_slb.Id,
        }));
        this.FirstSlbListenerProtocol = sampleDs.Apply(sampleDs => sampleDs.SlbListeners[0].Protocol);
    }

    [Output("firstSlbListenerProtocol")]
    public Output<string> FirstSlbListenerProtocol { get; set; }
}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

sample_ds = alicloud.slb.get_listeners(load_balancer_id=alicloud_slb["sample_slb"]["id"])
pulumi.export("firstSlbListenerProtocol", sample_ds.slb_listeners[0]["protocol"])

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const sampleDs = alicloud_slb_sample_slb.id.apply(id => alicloud.slb.getListeners({
    loadBalancerId: id,
}, { async: true }));

export const firstSlbListenerProtocol = sampleDs.slbListeners[0].protocol;

Using GetListeners

function getListeners(args: GetListenersArgs, opts?: InvokeOptions): Promise<GetListenersResult>

function  get_listeners(description_regex=None, frontend_port=None, load_balancer_id=None, output_file=None, protocol=None, opts=None)

func GetListeners(ctx *Context, args *GetListenersArgs, opts ...InvokeOption) (*GetListenersResult, error)

public static class GetListeners {
    public static Task<GetListenersResult> InvokeAsync(GetListenersArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

LoadBalancerId string: ID of the SLB with listeners.
DescriptionRegex string: A regex string to filter results by SLB listener description.
FrontendPort int: Filter listeners by the specified frontend port.
OutputFile string
Protocol string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

LoadBalancerId string: ID of the SLB with listeners.
DescriptionRegex string: A regex string to filter results by SLB listener description.
FrontendPort int: Filter listeners by the specified frontend port.
OutputFile string
Protocol string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

loadBalancerId string: ID of the SLB with listeners.
descriptionRegex string: A regex string to filter results by SLB listener description.
frontendPort number: Filter listeners by the specified frontend port.
outputFile string
protocol string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

load_balancer_id str: ID of the SLB with listeners.
description_regex str: A regex string to filter results by SLB listener description.
frontend_port float: Filter listeners by the specified frontend port.
output_file str
protocol str: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.

GetListeners Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
LoadBalancerId string
SlbListeners List<Pulumi.AliCloud.Slb.Outputs.GetListenersSlbListener>: A list of SLB listeners. Each element contains the following attributes:
DescriptionRegex string
FrontendPort int: Frontend port used to receive incoming traffic and distribute it to the backend servers.
OutputFile string
Protocol string: Listener protocol. Possible values: http, https, tcp and udp.

Id string: The provider-assigned unique ID for this managed resource.
LoadBalancerId string
SlbListeners []GetListenersSlbListener: A list of SLB listeners. Each element contains the following attributes:
DescriptionRegex string
FrontendPort int: Frontend port used to receive incoming traffic and distribute it to the backend servers.
OutputFile string
Protocol string: Listener protocol. Possible values: http, https, tcp and udp.

id string: The provider-assigned unique ID for this managed resource.
loadBalancerId string
slbListeners GetListenersSlbListener[]: A list of SLB listeners. Each element contains the following attributes:
descriptionRegex string
frontendPort number: Frontend port used to receive incoming traffic and distribute it to the backend servers.
outputFile string
protocol string: Listener protocol. Possible values: http, https, tcp and udp.

id str: The provider-assigned unique ID for this managed resource.
load_balancer_id str
slb_listeners List[GetListenersSlbListener]: A list of SLB listeners. Each element contains the following attributes:
description_regex str
frontend_port float: Frontend port used to receive incoming traffic and distribute it to the backend servers.
output_file str
protocol str: Listener protocol. Possible values: http, https, tcp and udp.

Supporting Types

GetListenersSlbListener

See the output API doc for this type.

BackendPort int: Port opened on the backend server to receive requests.
Bandwidth int: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
CaCertificateId string: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
Cookie string: Cookie configured by the backend server. Only available when the sticky_session_type is server.
CookieTimeout int: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
Description string: The description of slb listener.
EnableHttp2 string: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
EstablishedTimeout int: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
FrontendPort int: Filter listeners by the specified frontend port.
Gzip string: Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
HealthCheck string: Indicate whether health check is enabled of not. Possible values are on and off.
HealthCheckConnectPort int: Port used for health check.
HealthCheckConnectTimeout int: Amount of time in seconds to wait for the response for a health check.
HealthCheckDomain string: 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).
HealthCheckHttpCode string: 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).
HealthCheckInterval int: Time interval between two consecutive health checks.
HealthCheckTimeout int: 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.
HealthCheckType string: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
HealthCheckUri string: URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
HealthyThreshold int: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
IdleTimeout int: Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
MasterSlaveServerGroupId string: ID of the active/standby server group.
PersistenceTimeout int: 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.
Protocol string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
RequestTimeout int: 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.
Scheduler string: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
SecurityStatus string: Security status. Only available when the protocol is https.
ServerCertificateId string
ServerGroupId string: ID of the linked VServer group.
SslCertificateId string: ID of the server certificate. Only available when the protocol is https.
Status string: Listener status.
StickySession string: 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.
StickySessionType string: 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.
TlsCipherPolicy string: 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.
UnhealthyThreshold int: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
XForwardedFor string: 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.
XForwardedForSlbId string: 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.
XForwardedForSlbIp string: 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.
XForwardedForSlbProto string: 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.

BackendPort int: Port opened on the backend server to receive requests.
Bandwidth int: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
CaCertificateId string: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
Cookie string: Cookie configured by the backend server. Only available when the sticky_session_type is server.
CookieTimeout int: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
Description string: The description of slb listener.
EnableHttp2 string: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
EstablishedTimeout int: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
FrontendPort int: Filter listeners by the specified frontend port.
Gzip string: Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
HealthCheck string: Indicate whether health check is enabled of not. Possible values are on and off.
HealthCheckConnectPort int: Port used for health check.
HealthCheckConnectTimeout int: Amount of time in seconds to wait for the response for a health check.
HealthCheckDomain string: 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).
HealthCheckHttpCode string: 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).
HealthCheckInterval int: Time interval between two consecutive health checks.
HealthCheckTimeout int: 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.
HealthCheckType string: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
HealthCheckUri string: URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
HealthyThreshold int: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
IdleTimeout int: Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
MasterSlaveServerGroupId string: ID of the active/standby server group.
PersistenceTimeout int: 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.
Protocol string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
RequestTimeout int: 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.
Scheduler string: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
SecurityStatus string: Security status. Only available when the protocol is https.
ServerCertificateId string
ServerGroupId string: ID of the linked VServer group.
SslCertificateId string: ID of the server certificate. Only available when the protocol is https.
Status string: Listener status.
StickySession string: 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.
StickySessionType string: 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.
TlsCipherPolicy string: 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.
UnhealthyThreshold int: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
XForwardedFor string: 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.
XForwardedForSlbId string: 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.
XForwardedForSlbIp string: 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.
XForwardedForSlbProto string: 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.

backendPort number: Port opened on the backend server to receive requests.
bandwidth number: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
caCertificateId string: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie string: Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookieTimeout number: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description string: The description of slb listener.
enableHttp2 string: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
establishedTimeout number: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontendPort number: Filter listeners by the specified frontend port.
gzip string: Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
healthCheck string: Indicate whether health check is enabled of not. Possible values are on and off.
healthCheckConnectPort number: Port used for health check.
healthCheckConnectTimeout number: Amount of time in seconds to wait for the response for a health check.
healthCheckDomain string: 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).
healthCheckHttpCode string: 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).
healthCheckInterval number: Time interval between two consecutive health checks.
healthCheckTimeout number: 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.
healthCheckType string: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
healthCheckUri string: URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthyThreshold number: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idleTimeout number: Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
masterSlaveServerGroupId string: ID of the active/standby server group.
persistenceTimeout number: 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.
protocol string: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
requestTimeout number: 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.
scheduler string: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
securityStatus string: Security status. Only available when the protocol is https.
serverCertificateId string
serverGroupId string: ID of the linked VServer group.
sslCertificateId string: ID of the server certificate. Only available when the protocol is https.
status string: Listener status.
stickySession string: 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.
stickySessionType string: 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.
tlsCipherPolicy string: 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.
unhealthyThreshold number: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
xForwardedFor string: 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.
xForwardedForSlbId string: 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.
xForwardedForSlbIp string: 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.
xForwardedForSlbProto string: 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.

backend_port float: Port opened on the backend server to receive requests.
bandwidth float: Peak bandwidth. If the value is set to -1, the listener is not limited by bandwidth.
caCertificateId str: ID of the CA certificate (only required when two-way authentication is used). Only available when the protocol is https.
cookie str: Cookie configured by the backend server. Only available when the sticky_session_type is server.
cookie_timeout float: Cookie timeout in seconds. Only available when the sticky_session_type is insert.
description str: The description of slb listener.
enable_http2 str: Whether to enable https listener support http2 or not. Valid values are on and off. Default to on.
established_timeout float: Connection timeout in seconds for the Layer 4 TCP listener. Only available when the protocol is tcp.
frontend_port float: Filter listeners by the specified frontend port.
gzip str: Indicate whether Gzip compression is enabled or not. Possible values are on and off. Only available when the protocol is http or https.
healthCheckConnectTimeout float: Amount of time in seconds to wait for the response for a health check.
health_check str: Indicate whether health check is enabled of not. Possible values are on and off.
health_check_connect_port float: Port used for health check.
health_check_domain str: 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).
health_check_http_code str: 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).
health_check_interval float: Time interval between two consecutive health checks.
health_check_timeout float: 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.
health_check_type str: Health check method. Possible values are tcp and http. Only available when the protocol is tcp.
health_check_uri str: URI used for health check. Only available when the protocol is http, https or tcp (in this case health_check_type must be http).
healthy_threshold float: Number of consecutive successes of health check performed on the same ECS instance (from failure to success).
idle_timeout float: Timeout of http or https listener established connection idle timeout. Valid value range: [1-60] in seconds. Default to 15.
master_slave_server_group_id str: ID of the active/standby server group.
persistence_timeout float: 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.
protocol str: Filter listeners by the specified protocol. Valid values: http, https, tcp and udp.
request_timeout float: 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.
scheduler str: Algorithm used to distribute traffic. Possible values: wrr (weighted round robin), wlc (weighted least connection) and rr (round robin).
securityStatus str: Security status. Only available when the protocol is https.
server_certificate_id str
server_group_id str: ID of the linked VServer group.
ssl_certificate_id str: ID of the server certificate. Only available when the protocol is https.
status str: Listener status.
sticky_session str: 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.
sticky_session_type str: 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.
tls_cipher_policy str: 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.
unhealthy_threshold float: Number of consecutive failures of health check performed on the same ECS instance (from success to failure).
xForwardedForSlbId str: 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.
xForwardedForSlbIp str: 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.
xForwardedForSlbProto str: 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.
x_forwarded_for str: 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.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud