1. Packages
  2. Volcengine
  3. API Docs
  4. nlb
  5. getListeners
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.nlb.getListeners

volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    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(listener_ids: Optional[Sequence[str]] = None,
                  listener_name: Optional[str] = None,
                  load_balancer_id: Optional[str] = None,
                  output_file: Optional[str] = None,
                  protocol: Optional[str] = None,
                  tags: Optional[Sequence[GetListenersTag]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetListenersResult
def get_listeners_output(listener_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  listener_name: Optional[pulumi.Input[str]] = None,
                  load_balancer_id: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  protocol: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetListenersTagArgs]]]] = 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:nlb/getListeners:getListeners
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getListeners Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners List<GetListenersListener>
    TotalCount int
    ListenerIds List<string>
    ListenerName string
    LoadBalancerId string
    OutputFile string
    Protocol string
    Tags List<GetListenersTag>
    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners []GetListenersListener
    TotalCount int
    ListenerIds []string
    ListenerName string
    LoadBalancerId string
    OutputFile string
    Protocol string
    Tags []GetListenersTag
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<GetListenersListener>
    totalCount Integer
    listenerIds List<String>
    listenerName String
    loadBalancerId String
    outputFile String
    protocol String
    tags List<GetListenersTag>
    id string
    The provider-assigned unique ID for this managed resource.
    listeners GetListenersListener[]
    totalCount number
    listenerIds string[]
    listenerName string
    loadBalancerId string
    outputFile string
    protocol string
    tags GetListenersTag[]
    id str
    The provider-assigned unique ID for this managed resource.
    listeners Sequence[GetListenersListener]
    total_count int
    listener_ids Sequence[str]
    listener_name str
    load_balancer_id str
    output_file str
    protocol str
    tags Sequence[GetListenersTag]
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<Property Map>
    totalCount Number
    listenerIds List<String>
    listenerName String
    loadBalancerId String
    outputFile String
    protocol String
    tags List<Property Map>

    Supporting Types

    GetListenersListener

    ConnectionTimeout int
    The connection timeout of the listener.
    CreateTime string
    The creation time of the listener.
    Description string
    The description of the listener.
    Enabled bool
    Whether to enable the listener. Valid values: true, false. true: Enable. false: Disable.
    EndPort int
    The end port of the full port listening.
    ListenerId string
    The ID of the listener.
    ListenerName string
    The name of the listener.
    LoadBalancerId string
    The ID of the NLB instance.
    Port int
    The port used by the listener. 0 indicates that full port listening is enabled.
    Protocol string
    The protocol of the listener. Valid values: TCP, UDP, TLS.
    ServerGroupId string
    The ID of the server group associated with the listener.
    StartPort int
    The start port of the full port listening.
    Status string
    The status of the listener. Valid values: Creating, Active, Deleting, Disabled. Creating: The listener is being created. Active: The listener is running. Deleting: The listener is being deleted. Disabled: The listener is disabled.
    Tags List<GetListenersListenerTag>
    Tags.
    UpdateTime string
    The update time of the listener.
    ConnectionTimeout int
    The connection timeout of the listener.
    CreateTime string
    The creation time of the listener.
    Description string
    The description of the listener.
    Enabled bool
    Whether to enable the listener. Valid values: true, false. true: Enable. false: Disable.
    EndPort int
    The end port of the full port listening.
    ListenerId string
    The ID of the listener.
    ListenerName string
    The name of the listener.
    LoadBalancerId string
    The ID of the NLB instance.
    Port int
    The port used by the listener. 0 indicates that full port listening is enabled.
    Protocol string
    The protocol of the listener. Valid values: TCP, UDP, TLS.
    ServerGroupId string
    The ID of the server group associated with the listener.
    StartPort int
    The start port of the full port listening.
    Status string
    The status of the listener. Valid values: Creating, Active, Deleting, Disabled. Creating: The listener is being created. Active: The listener is running. Deleting: The listener is being deleted. Disabled: The listener is disabled.
    Tags []GetListenersListenerTag
    Tags.
    UpdateTime string
    The update time of the listener.
    connectionTimeout Integer
    The connection timeout of the listener.
    createTime String
    The creation time of the listener.
    description String
    The description of the listener.
    enabled Boolean
    Whether to enable the listener. Valid values: true, false. true: Enable. false: Disable.
    endPort Integer
    The end port of the full port listening.
    listenerId String
    The ID of the listener.
    listenerName String
    The name of the listener.
    loadBalancerId String
    The ID of the NLB instance.
    port Integer
    The port used by the listener. 0 indicates that full port listening is enabled.
    protocol String
    The protocol of the listener. Valid values: TCP, UDP, TLS.
    serverGroupId String
    The ID of the server group associated with the listener.
    startPort Integer
    The start port of the full port listening.
    status String
    The status of the listener. Valid values: Creating, Active, Deleting, Disabled. Creating: The listener is being created. Active: The listener is running. Deleting: The listener is being deleted. Disabled: The listener is disabled.
    tags List<GetListenersListenerTag>
    Tags.
    updateTime String
    The update time of the listener.
    connectionTimeout number
    The connection timeout of the listener.
    createTime string
    The creation time of the listener.
    description string
    The description of the listener.
    enabled boolean
    Whether to enable the listener. Valid values: true, false. true: Enable. false: Disable.
    endPort number
    The end port of the full port listening.
    listenerId string
    The ID of the listener.
    listenerName string
    The name of the listener.
    loadBalancerId string
    The ID of the NLB instance.
    port number
    The port used by the listener. 0 indicates that full port listening is enabled.
    protocol string
    The protocol of the listener. Valid values: TCP, UDP, TLS.
    serverGroupId string
    The ID of the server group associated with the listener.
    startPort number
    The start port of the full port listening.
    status string
    The status of the listener. Valid values: Creating, Active, Deleting, Disabled. Creating: The listener is being created. Active: The listener is running. Deleting: The listener is being deleted. Disabled: The listener is disabled.
    tags GetListenersListenerTag[]
    Tags.
    updateTime string
    The update time of the listener.
    connection_timeout int
    The connection timeout of the listener.
    create_time str
    The creation time of the listener.
    description str
    The description of the listener.
    enabled bool
    Whether to enable the listener. Valid values: true, false. true: Enable. false: Disable.
    end_port int
    The end port of the full port listening.
    listener_id str
    The ID of the listener.
    listener_name str
    The name of the listener.
    load_balancer_id str
    The ID of the NLB instance.
    port int
    The port used by the listener. 0 indicates that full port listening is enabled.
    protocol str
    The protocol of the listener. Valid values: TCP, UDP, TLS.
    server_group_id str
    The ID of the server group associated with the listener.
    start_port int
    The start port of the full port listening.
    status str
    The status of the listener. Valid values: Creating, Active, Deleting, Disabled. Creating: The listener is being created. Active: The listener is running. Deleting: The listener is being deleted. Disabled: The listener is disabled.
    tags Sequence[GetListenersListenerTag]
    Tags.
    update_time str
    The update time of the listener.
    connectionTimeout Number
    The connection timeout of the listener.
    createTime String
    The creation time of the listener.
    description String
    The description of the listener.
    enabled Boolean
    Whether to enable the listener. Valid values: true, false. true: Enable. false: Disable.
    endPort Number
    The end port of the full port listening.
    listenerId String
    The ID of the listener.
    listenerName String
    The name of the listener.
    loadBalancerId String
    The ID of the NLB instance.
    port Number
    The port used by the listener. 0 indicates that full port listening is enabled.
    protocol String
    The protocol of the listener. Valid values: TCP, UDP, TLS.
    serverGroupId String
    The ID of the server group associated with the listener.
    startPort Number
    The start port of the full port listening.
    status String
    The status of the listener. Valid values: Creating, Active, Deleting, Disabled. Creating: The listener is being created. Active: The listener is running. Deleting: The listener is being deleted. Disabled: The listener is disabled.
    tags List<Property Map>
    Tags.
    updateTime String
    The update time of the listener.

    GetListenersListenerTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    GetListenersTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Try Pulumi Cloud free. Your team will thank you.