Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. alb
  5. getListeners
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.alb.getListeners

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

    Use this data source to query detailed information of alb listeners

    Example Usage

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

const foo = volcengine.alb.getListeners({});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.alb.get_listeners()

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/alb"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := alb.GetListeners(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Alb.GetListeners.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.alb.AlbFunctions;
import com.pulumi.volcengine.alb.inputs.GetListenersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = AlbFunctions.getListeners();

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:alb:getListeners
      Arguments: {}

    Using getListeners

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getListeners(args: GetListenersArgs, opts?: InvokeOptions): Promise<GetListenersResult>
function getListenersOutput(args: GetListenersOutputArgs, opts?: InvokeOptions): Output<GetListenersResult>
    def get_listeners(ids: Optional[Sequence[str]] = None,
                  listener_name: Optional[str] = None,
                  load_balancer_id: Optional[str] = None,
                  name_regex: Optional[str] = None,
                  output_file: Optional[str] = None,
                  project_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetListenersResult
def get_listeners_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  listener_name: Optional[pulumi.Input[str]] = None,
                  load_balancer_id: Optional[pulumi.Input[str]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  project_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetListenersResult]
    func GetListeners(ctx *Context, args *GetListenersArgs, opts ...InvokeOption) (*GetListenersResult, error)
func GetListenersOutput(ctx *Context, args *GetListenersOutputArgs, opts ...InvokeOption) GetListenersResultOutput

    > Note: This function is named GetListeners in the Go SDK.

    public static class GetListeners 
{
    public static Task<GetListenersResult> InvokeAsync(GetListenersArgs args, InvokeOptions? opts = null)
    public static Output<GetListenersResult> Invoke(GetListenersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetListenersResult> getListeners(GetListenersArgs args, InvokeOptions options)
public static Output<GetListenersResult> getListeners(GetListenersArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:alb/getListeners:getListeners
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of Listener IDs.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Alb.
    NameRegex string
    A Name Regex of Listener.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of the listener.
    Ids []string
    A list of Listener IDs.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Alb.
    NameRegex string
    A Name Regex of Listener.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of the listener.
    ids List<String>
    A list of Listener IDs.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Alb.
    nameRegex String
    A Name Regex of Listener.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of the listener.
    ids string[]
    A list of Listener IDs.
    listenerName string
    The name of the Listener.
    loadBalancerId string
    The id of the Alb.
    nameRegex string
    A Name Regex of Listener.
    outputFile string
    File name where to save data source results.
    projectName string
    The project name of the listener.
    ids Sequence[str]
    A list of Listener IDs.
    listener_name str
    The name of the Listener.
    load_balancer_id str
    The id of the Alb.
    name_regex str
    A Name Regex of Listener.
    output_file str
    File name where to save data source results.
    project_name str
    The project name of the listener.
    ids List<String>
    A list of Listener IDs.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Alb.
    nameRegex String
    A Name Regex of Listener.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of the listener.

    getListeners Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners List<GetListenersListener>
    The collection of Listener query.
    TotalCount int
    The total count of Listener query.
    Ids List<string>
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The load balancer ID that the listener belongs to.
    NameRegex string
    OutputFile string
    ProjectName string
    The project name of the listener.
    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners []GetListenersListener
    The collection of Listener query.
    TotalCount int
    The total count of Listener query.
    Ids []string
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The load balancer ID that the listener belongs to.
    NameRegex string
    OutputFile string
    ProjectName string
    The project name of the listener.
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<GetListenersListener>
    The collection of Listener query.
    totalCount Integer
    The total count of Listener query.
    ids List<String>
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The load balancer ID that the listener belongs to.
    nameRegex String
    outputFile String
    projectName String
    The project name of the listener.
    id string
    The provider-assigned unique ID for this managed resource.
    listeners GetListenersListener[]
    The collection of Listener query.
    totalCount number
    The total count of Listener query.
    ids string[]
    listenerName string
    The name of the Listener.
    loadBalancerId string
    The load balancer ID that the listener belongs to.
    nameRegex string
    outputFile string
    projectName string
    The project name of the listener.
    id str
    The provider-assigned unique ID for this managed resource.
    listeners Sequence[GetListenersListener]
    The collection of Listener query.
    total_count int
    The total count of Listener query.
    ids Sequence[str]
    listener_name str
    The name of the Listener.
    load_balancer_id str
    The load balancer ID that the listener belongs to.
    name_regex str
    output_file str
    project_name str
    The project name of the listener.
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<Property Map>
    The collection of Listener query.
    totalCount Number
    The total count of Listener query.
    ids List<String>
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The load balancer ID that the listener belongs to.
    nameRegex String
    outputFile String
    projectName String
    The project name of the listener.

    Supporting Types

    GetListenersListener

    AclIds List<string>
    The ID of the access control policy group bound to the listener, only returned when the AclStatus parameter is on.
    AclStatus string
    Whether to enable the access control function,valid value is on or off.
    AclType string
    The access control type.
    CaCertificateId string
    CA certificate ID associated with HTTPS listener.
    CertCenterCertificateId string
    The certificate id associated with the listener. Source is cert_center.
    CertificateId string
    The server certificate ID that domain used.
    CertificateSource string
    The source of the certificate.
    CreateTime string
    The create time of the Listener.
    CustomizedCfgId string
    The customized configuration ID, the value is empty string when not bound.
    Description string
    The description of listener.
    DomainExtensions List<GetListenersListenerDomainExtension>
    The HTTPS listener association list of extension domains for.
    EnableHttp2 string
    The HTTP2 feature switch,valid value is on or off.
    EnableQuic string
    The QUIC feature switch,valid value is on or off.
    Enabled string
    The enable status of the Listener.
    Id string
    The ID of the Listener.
    ListenerId string
    The ID of the Listener.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Alb.
    Port int
    The port receiving request of the Listener.
    ProjectName string
    The project name of the listener.
    Protocol string
    The protocol of the Listener.
    ServerGroupId string
    The ID of server group.
    ServerGroups List<GetListenersListenerServerGroup>
    The list of server groups with associated listeners.
    Status string
    The status of the Listener.
    UpdateTime string
    The update time of the Listener.
    AclIds []string
    The ID of the access control policy group bound to the listener, only returned when the AclStatus parameter is on.
    AclStatus string
    Whether to enable the access control function,valid value is on or off.
    AclType string
    The access control type.
    CaCertificateId string
    CA certificate ID associated with HTTPS listener.
    CertCenterCertificateId string
    The certificate id associated with the listener. Source is cert_center.
    CertificateId string
    The server certificate ID that domain used.
    CertificateSource string
    The source of the certificate.
    CreateTime string
    The create time of the Listener.
    CustomizedCfgId string
    The customized configuration ID, the value is empty string when not bound.
    Description string
    The description of listener.
    DomainExtensions []GetListenersListenerDomainExtension
    The HTTPS listener association list of extension domains for.
    EnableHttp2 string
    The HTTP2 feature switch,valid value is on or off.
    EnableQuic string
    The QUIC feature switch,valid value is on or off.
    Enabled string
    The enable status of the Listener.
    Id string
    The ID of the Listener.
    ListenerId string
    The ID of the Listener.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Alb.
    Port int
    The port receiving request of the Listener.
    ProjectName string
    The project name of the listener.
    Protocol string
    The protocol of the Listener.
    ServerGroupId string
    The ID of server group.
    ServerGroups []GetListenersListenerServerGroup
    The list of server groups with associated listeners.
    Status string
    The status of the Listener.
    UpdateTime string
    The update time of the Listener.
    aclIds List<String>
    The ID of the access control policy group bound to the listener, only returned when the AclStatus parameter is on.
    aclStatus String
    Whether to enable the access control function,valid value is on or off.
    aclType String
    The access control type.
    caCertificateId String
    CA certificate ID associated with HTTPS listener.
    certCenterCertificateId String
    The certificate id associated with the listener. Source is cert_center.
    certificateId String
    The server certificate ID that domain used.
    certificateSource String
    The source of the certificate.
    createTime String
    The create time of the Listener.
    customizedCfgId String
    The customized configuration ID, the value is empty string when not bound.
    description String
    The description of listener.
    domainExtensions List<GetListenersListenerDomainExtension>
    The HTTPS listener association list of extension domains for.
    enableHttp2 String
    The HTTP2 feature switch,valid value is on or off.
    enableQuic String
    The QUIC feature switch,valid value is on or off.
    enabled String
    The enable status of the Listener.
    id String
    The ID of the Listener.
    listenerId String
    The ID of the Listener.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Alb.
    port Integer
    The port receiving request of the Listener.
    projectName String
    The project name of the listener.
    protocol String
    The protocol of the Listener.
    serverGroupId String
    The ID of server group.
    serverGroups List<GetListenersListenerServerGroup>
    The list of server groups with associated listeners.
    status String
    The status of the Listener.
    updateTime String
    The update time of the Listener.
    aclIds string[]
    The ID of the access control policy group bound to the listener, only returned when the AclStatus parameter is on.
    aclStatus string
    Whether to enable the access control function,valid value is on or off.
    aclType string
    The access control type.
    caCertificateId string
    CA certificate ID associated with HTTPS listener.
    certCenterCertificateId string
    The certificate id associated with the listener. Source is cert_center.
    certificateId string
    The server certificate ID that domain used.
    certificateSource string
    The source of the certificate.
    createTime string
    The create time of the Listener.
    customizedCfgId string
    The customized configuration ID, the value is empty string when not bound.
    description string
    The description of listener.
    domainExtensions GetListenersListenerDomainExtension[]
    The HTTPS listener association list of extension domains for.
    enableHttp2 string
    The HTTP2 feature switch,valid value is on or off.
    enableQuic string
    The QUIC feature switch,valid value is on or off.
    enabled string
    The enable status of the Listener.
    id string
    The ID of the Listener.
    listenerId string
    The ID of the Listener.
    listenerName string
    The name of the Listener.
    loadBalancerId string
    The id of the Alb.
    port number
    The port receiving request of the Listener.
    projectName string
    The project name of the listener.
    protocol string
    The protocol of the Listener.
    serverGroupId string
    The ID of server group.
    serverGroups GetListenersListenerServerGroup[]
    The list of server groups with associated listeners.
    status string
    The status of the Listener.
    updateTime string
    The update time of the Listener.
    acl_ids Sequence[str]
    The ID of the access control policy group bound to the listener, only returned when the AclStatus parameter is on.
    acl_status str
    Whether to enable the access control function,valid value is on or off.
    acl_type str
    The access control type.
    ca_certificate_id str
    CA certificate ID associated with HTTPS listener.
    cert_center_certificate_id str
    The certificate id associated with the listener. Source is cert_center.
    certificate_id str
    The server certificate ID that domain used.
    certificate_source str
    The source of the certificate.
    create_time str
    The create time of the Listener.
    customized_cfg_id str
    The customized configuration ID, the value is empty string when not bound.
    description str
    The description of listener.
    domain_extensions Sequence[GetListenersListenerDomainExtension]
    The HTTPS listener association list of extension domains for.
    enable_http2 str
    The HTTP2 feature switch,valid value is on or off.
    enable_quic str
    The QUIC feature switch,valid value is on or off.
    enabled str
    The enable status of the Listener.
    id str
    The ID of the Listener.
    listener_id str
    The ID of the Listener.
    listener_name str
    The name of the Listener.
    load_balancer_id str
    The id of the Alb.
    port int
    The port receiving request of the Listener.
    project_name str
    The project name of the listener.
    protocol str
    The protocol of the Listener.
    server_group_id str
    The ID of server group.
    server_groups Sequence[GetListenersListenerServerGroup]
    The list of server groups with associated listeners.
    status str
    The status of the Listener.
    update_time str
    The update time of the Listener.
    aclIds List<String>
    The ID of the access control policy group bound to the listener, only returned when the AclStatus parameter is on.
    aclStatus String
    Whether to enable the access control function,valid value is on or off.
    aclType String
    The access control type.
    caCertificateId String
    CA certificate ID associated with HTTPS listener.
    certCenterCertificateId String
    The certificate id associated with the listener. Source is cert_center.
    certificateId String
    The server certificate ID that domain used.
    certificateSource String
    The source of the certificate.
    createTime String
    The create time of the Listener.
    customizedCfgId String
    The customized configuration ID, the value is empty string when not bound.
    description String
    The description of listener.
    domainExtensions List<Property Map>
    The HTTPS listener association list of extension domains for.
    enableHttp2 String
    The HTTP2 feature switch,valid value is on or off.
    enableQuic String
    The QUIC feature switch,valid value is on or off.
    enabled String
    The enable status of the Listener.
    id String
    The ID of the Listener.
    listenerId String
    The ID of the Listener.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Alb.
    port Number
    The port receiving request of the Listener.
    projectName String
    The project name of the listener.
    protocol String
    The protocol of the Listener.
    serverGroupId String
    The ID of server group.
    serverGroups List<Property Map>
    The list of server groups with associated listeners.
    status String
    The status of the Listener.
    updateTime String
    The update time of the Listener.

    GetListenersListenerDomainExtension

    CertificateId string
    The server certificate ID that domain used.
    Domain string
    The domain.
    DomainExtensionId string
    The extension domain ID.
    ListenerId string
    The ID of the Listener.
    CertificateId string
    The server certificate ID that domain used.
    Domain string
    The domain.
    DomainExtensionId string
    The extension domain ID.
    ListenerId string
    The ID of the Listener.
    certificateId String
    The server certificate ID that domain used.
    domain String
    The domain.
    domainExtensionId String
    The extension domain ID.
    listenerId String
    The ID of the Listener.
    certificateId string
    The server certificate ID that domain used.
    domain string
    The domain.
    domainExtensionId string
    The extension domain ID.
    listenerId string
    The ID of the Listener.
    certificate_id str
    The server certificate ID that domain used.
    domain str
    The domain.
    domain_extension_id str
    The extension domain ID.
    listener_id str
    The ID of the Listener.
    certificateId String
    The server certificate ID that domain used.
    domain String
    The domain.
    domainExtensionId String
    The extension domain ID.
    listenerId String
    The ID of the Listener.

    GetListenersListenerServerGroup

    ServerGroupId string
    The ID of server group.
    ServerGroupName string
    The name of server group.
    ServerGroupId string
    The ID of server group.
    ServerGroupName string
    The name of server group.
    serverGroupId String
    The ID of server group.
    serverGroupName String
    The name of server group.
    serverGroupId string
    The ID of server group.
    serverGroupName string
    The name of server group.
    server_group_id str
    The ID of server group.
    server_group_name str
    The name of server group.
    serverGroupId String
    The ID of server group.
    serverGroupName String
    The name of server group.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
    volcengine/pulumi-volcengine