1. Packages
  2. Gcore Provider
  3. API Docs
  4. getCloudLoadBalancerListener
Viewing docs for gcore 2.0.0-alpha.4
published on Friday, Apr 17, 2026 by g-core
Schema (JSON)
g-core/terraform-provider-gcore

gcore.getCloudLoadBalancerListener

Viewing docs for gcore 2.0.0-alpha.4
published on Friday, Apr 17, 2026 by g-core
Schema (JSON)
g-core/terraform-provider-gcore

    Load balancer listeners handle incoming traffic on specified protocols and ports, forwarding requests to backend pools.

    Example Usage

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

const exampleCloudLoadBalancerListener = gcore.getCloudLoadBalancerListener({
    projectId: 1,
    regionId: 1,
    listenerId: "00000000-0000-4000-8000-000000000000",
    showStats: true,
});

    import pulumi
import pulumi_gcore as gcore

example_cloud_load_balancer_listener = gcore.get_cloud_load_balancer_listener(project_id=1,
    region_id=1,
    listener_id="00000000-0000-4000-8000-000000000000",
    show_stats=True)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gcore.LookupCloudLoadBalancerListener(ctx, &gcore.LookupCloudLoadBalancerListenerArgs{
			ProjectId:  pulumi.Float64Ref(1),
			RegionId:   pulumi.Float64Ref(1),
			ListenerId: "00000000-0000-4000-8000-000000000000",
			ShowStats:  pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleCloudLoadBalancerListener = Gcore.GetCloudLoadBalancerListener.Invoke(new()
    {
        ProjectId = 1,
        RegionId = 1,
        ListenerId = "00000000-0000-4000-8000-000000000000",
        ShowStats = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.GcoreFunctions;
import com.pulumi.gcore.inputs.GetCloudLoadBalancerListenerArgs;
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 exampleCloudLoadBalancerListener = GcoreFunctions.getCloudLoadBalancerListener(GetCloudLoadBalancerListenerArgs.builder()
            .projectId(1)
            .regionId(1)
            .listenerId("00000000-0000-4000-8000-000000000000")
            .showStats(true)
            .build());

    }
}

    variables:
  exampleCloudLoadBalancerListener:
    fn::invoke:
      function: gcore:getCloudLoadBalancerListener
      arguments:
        projectId: 1
        regionId: 1
        listenerId: 00000000-0000-4000-8000-000000000000
        showStats: true

    Using getCloudLoadBalancerListener

    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 getCloudLoadBalancerListener(args: GetCloudLoadBalancerListenerArgs, opts?: InvokeOptions): Promise<GetCloudLoadBalancerListenerResult>
function getCloudLoadBalancerListenerOutput(args: GetCloudLoadBalancerListenerOutputArgs, opts?: InvokeOptions): Output<GetCloudLoadBalancerListenerResult>
    def get_cloud_load_balancer_listener(listener_id: Optional[str] = None,
                                     project_id: Optional[float] = None,
                                     region_id: Optional[float] = None,
                                     show_stats: Optional[bool] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetCloudLoadBalancerListenerResult
def get_cloud_load_balancer_listener_output(listener_id: Optional[pulumi.Input[str]] = None,
                                     project_id: Optional[pulumi.Input[float]] = None,
                                     region_id: Optional[pulumi.Input[float]] = None,
                                     show_stats: Optional[pulumi.Input[bool]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetCloudLoadBalancerListenerResult]
    func LookupCloudLoadBalancerListener(ctx *Context, args *LookupCloudLoadBalancerListenerArgs, opts ...InvokeOption) (*LookupCloudLoadBalancerListenerResult, error)
func LookupCloudLoadBalancerListenerOutput(ctx *Context, args *LookupCloudLoadBalancerListenerOutputArgs, opts ...InvokeOption) LookupCloudLoadBalancerListenerResultOutput

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

    public static class GetCloudLoadBalancerListener 
{
    public static Task<GetCloudLoadBalancerListenerResult> InvokeAsync(GetCloudLoadBalancerListenerArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudLoadBalancerListenerResult> Invoke(GetCloudLoadBalancerListenerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudLoadBalancerListenerResult> getCloudLoadBalancerListener(GetCloudLoadBalancerListenerArgs args, InvokeOptions options)
public static Output<GetCloudLoadBalancerListenerResult> getCloudLoadBalancerListener(GetCloudLoadBalancerListenerArgs args, InvokeOptions options)

    fn::invoke:
  function: gcore:index/getCloudLoadBalancerListener:getCloudLoadBalancerListener
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ListenerId string
    Listener ID
    ProjectId double
    Project ID
    RegionId double
    Region ID
    ShowStats bool
    Show stats
    ListenerId string
    Listener ID
    ProjectId float64
    Project ID
    RegionId float64
    Region ID
    ShowStats bool
    Show stats
    listenerId String
    Listener ID
    projectId Double
    Project ID
    regionId Double
    Region ID
    showStats Boolean
    Show stats
    listenerId string
    Listener ID
    projectId number
    Project ID
    regionId number
    Region ID
    showStats boolean
    Show stats
    listener_id str
    Listener ID
    project_id float
    Project ID
    region_id float
    Region ID
    show_stats bool
    Show stats
    listenerId String
    Listener ID
    projectId Number
    Project ID
    regionId Number
    Region ID
    showStats Boolean
    Show stats

    getCloudLoadBalancerListener Result

    The following output properties are available:

    AdminStateUp bool
    Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.
    AllowedCidrs List<string>
    Network CIDRs from which service will be accessible
    ConnectionLimit double
    Limit of simultaneous connections
    CreatorTaskId string
    Task that created this entity
    Id string
    Listener ID
    InsertHeaders Dictionary<string, string>
    Dictionary of additional header insertion into HTTP headers. Only used with HTTP and TERMINATED_HTTPS protocols.
    ListenerId string
    Listener ID
    LoadBalancerId string
    Load balancer ID
    Name string
    Load balancer listener name
    OperatingStatus string
    Listener operating status Available values: "DEGRADED", "DRAINING", "ERROR", "NO_MONITOR", "OFFLINE", "ONLINE".
    PoolCount double
    Number of pools (for UI)
    Protocol string
    Load balancer protocol Available values: "HTTP", "HTTPS", "PROMETHEUS", "TCP", "TERMINATED_HTTPS", "UDP".
    ProtocolPort double
    Protocol port
    ProvisioningStatus string
    Listener lifecycle status Available values: "ACTIVE", "DELETED", "ERROR", "PENDINGCREATE", "PENDINGDELETE", "PENDING_UPDATE".
    SecretId string
    ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS load balancer
    ShowStats bool
    Show stats
    SniSecretIds List<string>
    List of secret's ID containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners
    Stats GetCloudLoadBalancerListenerStats
    Statistics of the load balancer. It is available only in get functions by a flag.
    TimeoutClientData double
    Frontend client inactivity timeout in milliseconds
    UserLists List<GetCloudLoadBalancerListenerUserList>
    Load balancer listener users list
    ProjectId double
    Project ID
    RegionId double
    Region ID
    AdminStateUp bool
    Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.
    AllowedCidrs []string
    Network CIDRs from which service will be accessible
    ConnectionLimit float64
    Limit of simultaneous connections
    CreatorTaskId string
    Task that created this entity
    Id string
    Listener ID
    InsertHeaders map[string]string
    Dictionary of additional header insertion into HTTP headers. Only used with HTTP and TERMINATED_HTTPS protocols.
    ListenerId string
    Listener ID
    LoadBalancerId string
    Load balancer ID
    Name string
    Load balancer listener name
    OperatingStatus string
    Listener operating status Available values: "DEGRADED", "DRAINING", "ERROR", "NO_MONITOR", "OFFLINE", "ONLINE".
    PoolCount float64
    Number of pools (for UI)
    Protocol string
    Load balancer protocol Available values: "HTTP", "HTTPS", "PROMETHEUS", "TCP", "TERMINATED_HTTPS", "UDP".
    ProtocolPort float64
    Protocol port
    ProvisioningStatus string
    Listener lifecycle status Available values: "ACTIVE", "DELETED", "ERROR", "PENDINGCREATE", "PENDINGDELETE", "PENDING_UPDATE".
    SecretId string
    ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS load balancer
    ShowStats bool
    Show stats
    SniSecretIds []string
    List of secret's ID containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners
    Stats GetCloudLoadBalancerListenerStats
    Statistics of the load balancer. It is available only in get functions by a flag.
    TimeoutClientData float64
    Frontend client inactivity timeout in milliseconds
    UserLists []GetCloudLoadBalancerListenerUserList
    Load balancer listener users list
    ProjectId float64
    Project ID
    RegionId float64
    Region ID
    adminStateUp Boolean
    Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.
    allowedCidrs List<String>
    Network CIDRs from which service will be accessible
    connectionLimit Double
    Limit of simultaneous connections
    creatorTaskId String
    Task that created this entity
    id String
    Listener ID
    insertHeaders Map<String,String>
    Dictionary of additional header insertion into HTTP headers. Only used with HTTP and TERMINATED_HTTPS protocols.
    listenerId String
    Listener ID
    loadBalancerId String
    Load balancer ID
    name String
    Load balancer listener name
    operatingStatus String
    Listener operating status Available values: "DEGRADED", "DRAINING", "ERROR", "NO_MONITOR", "OFFLINE", "ONLINE".
    poolCount Double
    Number of pools (for UI)
    protocol String
    Load balancer protocol Available values: "HTTP", "HTTPS", "PROMETHEUS", "TCP", "TERMINATED_HTTPS", "UDP".
    protocolPort Double
    Protocol port
    provisioningStatus String
    Listener lifecycle status Available values: "ACTIVE", "DELETED", "ERROR", "PENDINGCREATE", "PENDINGDELETE", "PENDING_UPDATE".
    secretId String
    ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS load balancer
    showStats Boolean
    Show stats
    sniSecretIds List<String>
    List of secret's ID containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners
    stats GetCloudLoadBalancerListenerStats
    Statistics of the load balancer. It is available only in get functions by a flag.
    timeoutClientData Double
    Frontend client inactivity timeout in milliseconds
    userLists List<GetCloudLoadBalancerListenerUserList>
    Load balancer listener users list
    projectId Double
    Project ID
    regionId Double
    Region ID
    adminStateUp boolean
    Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.
    allowedCidrs string[]
    Network CIDRs from which service will be accessible
    connectionLimit number
    Limit of simultaneous connections
    creatorTaskId string
    Task that created this entity
    id string
    Listener ID
    insertHeaders {[key: string]: string}
    Dictionary of additional header insertion into HTTP headers. Only used with HTTP and TERMINATED_HTTPS protocols.
    listenerId string
    Listener ID
    loadBalancerId string
    Load balancer ID
    name string
    Load balancer listener name
    operatingStatus string
    Listener operating status Available values: "DEGRADED", "DRAINING", "ERROR", "NO_MONITOR", "OFFLINE", "ONLINE".
    poolCount number
    Number of pools (for UI)
    protocol string
    Load balancer protocol Available values: "HTTP", "HTTPS", "PROMETHEUS", "TCP", "TERMINATED_HTTPS", "UDP".
    protocolPort number
    Protocol port
    provisioningStatus string
    Listener lifecycle status Available values: "ACTIVE", "DELETED", "ERROR", "PENDINGCREATE", "PENDINGDELETE", "PENDING_UPDATE".
    secretId string
    ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS load balancer
    showStats boolean
    Show stats
    sniSecretIds string[]
    List of secret's ID containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners
    stats GetCloudLoadBalancerListenerStats
    Statistics of the load balancer. It is available only in get functions by a flag.
    timeoutClientData number
    Frontend client inactivity timeout in milliseconds
    userLists GetCloudLoadBalancerListenerUserList[]
    Load balancer listener users list
    projectId number
    Project ID
    regionId number
    Region ID
    admin_state_up bool
    Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.
    allowed_cidrs Sequence[str]
    Network CIDRs from which service will be accessible
    connection_limit float
    Limit of simultaneous connections
    creator_task_id str
    Task that created this entity
    id str
    Listener ID
    insert_headers Mapping[str, str]
    Dictionary of additional header insertion into HTTP headers. Only used with HTTP and TERMINATED_HTTPS protocols.
    listener_id str
    Listener ID
    load_balancer_id str
    Load balancer ID
    name str
    Load balancer listener name
    operating_status str
    Listener operating status Available values: "DEGRADED", "DRAINING", "ERROR", "NO_MONITOR", "OFFLINE", "ONLINE".
    pool_count float
    Number of pools (for UI)
    protocol str
    Load balancer protocol Available values: "HTTP", "HTTPS", "PROMETHEUS", "TCP", "TERMINATED_HTTPS", "UDP".
    protocol_port float
    Protocol port
    provisioning_status str
    Listener lifecycle status Available values: "ACTIVE", "DELETED", "ERROR", "PENDINGCREATE", "PENDINGDELETE", "PENDING_UPDATE".
    secret_id str
    ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS load balancer
    show_stats bool
    Show stats
    sni_secret_ids Sequence[str]
    List of secret's ID containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners
    stats GetCloudLoadBalancerListenerStats
    Statistics of the load balancer. It is available only in get functions by a flag.
    timeout_client_data float
    Frontend client inactivity timeout in milliseconds
    user_lists Sequence[GetCloudLoadBalancerListenerUserList]
    Load balancer listener users list
    project_id float
    Project ID
    region_id float
    Region ID
    adminStateUp Boolean
    Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.
    allowedCidrs List<String>
    Network CIDRs from which service will be accessible
    connectionLimit Number
    Limit of simultaneous connections
    creatorTaskId String
    Task that created this entity
    id String
    Listener ID
    insertHeaders Map<String>
    Dictionary of additional header insertion into HTTP headers. Only used with HTTP and TERMINATED_HTTPS protocols.
    listenerId String
    Listener ID
    loadBalancerId String
    Load balancer ID
    name String
    Load balancer listener name
    operatingStatus String
    Listener operating status Available values: "DEGRADED", "DRAINING", "ERROR", "NO_MONITOR", "OFFLINE", "ONLINE".
    poolCount Number
    Number of pools (for UI)
    protocol String
    Load balancer protocol Available values: "HTTP", "HTTPS", "PROMETHEUS", "TCP", "TERMINATED_HTTPS", "UDP".
    protocolPort Number
    Protocol port
    provisioningStatus String
    Listener lifecycle status Available values: "ACTIVE", "DELETED", "ERROR", "PENDINGCREATE", "PENDINGDELETE", "PENDING_UPDATE".
    secretId String
    ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS load balancer
    showStats Boolean
    Show stats
    sniSecretIds List<String>
    List of secret's ID containing PKCS12 format certificate/key bundles for TERMINATED_HTTPS or PROMETHEUS listeners
    stats Property Map
    Statistics of the load balancer. It is available only in get functions by a flag.
    timeoutClientData Number
    Frontend client inactivity timeout in milliseconds
    userLists List<Property Map>
    Load balancer listener users list
    projectId Number
    Project ID
    regionId Number
    Region ID

    Supporting Types

    GetCloudLoadBalancerListenerStats

    ActiveConnections double
    Currently active connections
    BytesIn double
    Total bytes received
    BytesOut double
    Total bytes sent
    RequestErrors double
    Total requests that were unable to be fulfilled
    TotalConnections double
    Total connections handled
    ActiveConnections float64
    Currently active connections
    BytesIn float64
    Total bytes received
    BytesOut float64
    Total bytes sent
    RequestErrors float64
    Total requests that were unable to be fulfilled
    TotalConnections float64
    Total connections handled
    activeConnections Double
    Currently active connections
    bytesIn Double
    Total bytes received
    bytesOut Double
    Total bytes sent
    requestErrors Double
    Total requests that were unable to be fulfilled
    totalConnections Double
    Total connections handled
    activeConnections number
    Currently active connections
    bytesIn number
    Total bytes received
    bytesOut number
    Total bytes sent
    requestErrors number
    Total requests that were unable to be fulfilled
    totalConnections number
    Total connections handled
    active_connections float
    Currently active connections
    bytes_in float
    Total bytes received
    bytes_out float
    Total bytes sent
    request_errors float
    Total requests that were unable to be fulfilled
    total_connections float
    Total connections handled
    activeConnections Number
    Currently active connections
    bytesIn Number
    Total bytes received
    bytesOut Number
    Total bytes sent
    requestErrors Number
    Total requests that were unable to be fulfilled
    totalConnections Number
    Total connections handled

    GetCloudLoadBalancerListenerUserList

    EncryptedPassword string
    Encrypted password to auth via Basic Authentication
    Username string
    Username to auth via Basic Authentication
    EncryptedPassword string
    Encrypted password to auth via Basic Authentication
    Username string
    Username to auth via Basic Authentication
    encryptedPassword String
    Encrypted password to auth via Basic Authentication
    username String
    Username to auth via Basic Authentication
    encryptedPassword string
    Encrypted password to auth via Basic Authentication
    username string
    Username to auth via Basic Authentication
    encrypted_password str
    Encrypted password to auth via Basic Authentication
    username str
    Username to auth via Basic Authentication
    encryptedPassword String
    Encrypted password to auth via Basic Authentication
    username String
    Username to auth via Basic Authentication

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    Viewing docs for gcore 2.0.0-alpha.4
    published on Friday, Apr 17, 2026 by g-core
    Schema (JSON)
    g-core/terraform-provider-gcore
      Try Pulumi Cloud free. Your team will thank you.