1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. clb
  6. getNlbListener
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.clb.getNlbListener

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::CLB::NLBListener

    Using getNlbListener

    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 getNlbListener(args: GetNlbListenerArgs, opts?: InvokeOptions): Promise<GetNlbListenerResult>
function getNlbListenerOutput(args: GetNlbListenerOutputArgs, opts?: InvokeOptions): Output<GetNlbListenerResult>
    def get_nlb_listener(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNlbListenerResult
def get_nlb_listener_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetNlbListenerResult]
    func LookupNlbListener(ctx *Context, args *LookupNlbListenerArgs, opts ...InvokeOption) (*LookupNlbListenerResult, error)
func LookupNlbListenerOutput(ctx *Context, args *LookupNlbListenerOutputArgs, opts ...InvokeOption) LookupNlbListenerResultOutput

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

    public static class GetNlbListener 
{
    public static Task<GetNlbListenerResult> InvokeAsync(GetNlbListenerArgs args, InvokeOptions? opts = null)
    public static Output<GetNlbListenerResult> Invoke(GetNlbListenerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNlbListenerResult> getNlbListener(GetNlbListenerArgs args, InvokeOptions options)
public static Output<GetNlbListenerResult> getNlbListener(GetNlbListenerArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:clb/getNlbListener:getNlbListener
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getNlbListener Result

    The following output properties are available:

    CertificateId string
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    ConnectionTimeout int
    Listener connection timeout (seconds)
    CreatedTime string
    Listener creation time
    Description string
    Listener description
    Enabled bool
    Listener enabled: true (enabled); false (disabled)
    EndPort int
    End port for all-port listening. Valid only when Port is 0.
    Healths List<Volcengine.GetNlbListenerHealth>
    Backend instance health check response information
    Id string
    Uniquely identifies the resource.
    ListenerId string
    Listener unique identifier
    ListenerName string
    Listener name
    LoadBalancerId string
    Load balancer instance ID
    Port int
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    Protocol string
    Listener protocol type: TCP, UDP, TLS
    SecurityPolicyId string
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    ServerGroupId string
    Server group ID associated with the listener
    StartPort int
    Start port for all-port listening. Valid only when Port is 0.
    Status string
    Listener status
    Tags List<Volcengine.GetNlbListenerTag>
    Resource tags
    UpdatedTime string
    Listener's most recent operation time
    CertificateId string
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    ConnectionTimeout int
    Listener connection timeout (seconds)
    CreatedTime string
    Listener creation time
    Description string
    Listener description
    Enabled bool
    Listener enabled: true (enabled); false (disabled)
    EndPort int
    End port for all-port listening. Valid only when Port is 0.
    Healths []GetNlbListenerHealth
    Backend instance health check response information
    Id string
    Uniquely identifies the resource.
    ListenerId string
    Listener unique identifier
    ListenerName string
    Listener name
    LoadBalancerId string
    Load balancer instance ID
    Port int
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    Protocol string
    Listener protocol type: TCP, UDP, TLS
    SecurityPolicyId string
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    ServerGroupId string
    Server group ID associated with the listener
    StartPort int
    Start port for all-port listening. Valid only when Port is 0.
    Status string
    Listener status
    Tags []GetNlbListenerTag
    Resource tags
    UpdatedTime string
    Listener's most recent operation time
    certificateId String
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connectionTimeout Integer
    Listener connection timeout (seconds)
    createdTime String
    Listener creation time
    description String
    Listener description
    enabled Boolean
    Listener enabled: true (enabled); false (disabled)
    endPort Integer
    End port for all-port listening. Valid only when Port is 0.
    healths List<GetNlbListenerHealth>
    Backend instance health check response information
    id String
    Uniquely identifies the resource.
    listenerId String
    Listener unique identifier
    listenerName String
    Listener name
    loadBalancerId String
    Load balancer instance ID
    port Integer
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol String
    Listener protocol type: TCP, UDP, TLS
    securityPolicyId String
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    serverGroupId String
    Server group ID associated with the listener
    startPort Integer
    Start port for all-port listening. Valid only when Port is 0.
    status String
    Listener status
    tags List<GetNlbListenerTag>
    Resource tags
    updatedTime String
    Listener's most recent operation time
    certificateId string
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connectionTimeout number
    Listener connection timeout (seconds)
    createdTime string
    Listener creation time
    description string
    Listener description
    enabled boolean
    Listener enabled: true (enabled); false (disabled)
    endPort number
    End port for all-port listening. Valid only when Port is 0.
    healths GetNlbListenerHealth[]
    Backend instance health check response information
    id string
    Uniquely identifies the resource.
    listenerId string
    Listener unique identifier
    listenerName string
    Listener name
    loadBalancerId string
    Load balancer instance ID
    port number
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol string
    Listener protocol type: TCP, UDP, TLS
    securityPolicyId string
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    serverGroupId string
    Server group ID associated with the listener
    startPort number
    Start port for all-port listening. Valid only when Port is 0.
    status string
    Listener status
    tags GetNlbListenerTag[]
    Resource tags
    updatedTime string
    Listener's most recent operation time
    certificate_id str
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connection_timeout int
    Listener connection timeout (seconds)
    created_time str
    Listener creation time
    description str
    Listener description
    enabled bool
    Listener enabled: true (enabled); false (disabled)
    end_port int
    End port for all-port listening. Valid only when Port is 0.
    healths Sequence[GetNlbListenerHealth]
    Backend instance health check response information
    id str
    Uniquely identifies the resource.
    listener_id str
    Listener unique identifier
    listener_name str
    Listener name
    load_balancer_id str
    Load balancer instance ID
    port int
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol str
    Listener protocol type: TCP, UDP, TLS
    security_policy_id str
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    server_group_id str
    Server group ID associated with the listener
    start_port int
    Start port for all-port listening. Valid only when Port is 0.
    status str
    Listener status
    tags Sequence[GetNlbListenerTag]
    Resource tags
    updated_time str
    Listener's most recent operation time
    certificateId String
    TLS listener server certificate ID. Only SSL certificates from the certificate center are supported.
    connectionTimeout Number
    Listener connection timeout (seconds)
    createdTime String
    Listener creation time
    description String
    Listener description
    enabled Boolean
    Listener enabled: true (enabled); false (disabled)
    endPort Number
    End port for all-port listening. Valid only when Port is 0.
    healths List<Property Map>
    Backend instance health check response information
    id String
    Uniquely identifies the resource.
    listenerId String
    Listener unique identifier
    listenerName String
    Listener name
    loadBalancerId String
    Load balancer instance ID
    port Number
    Port on which the listener receives requests. 0 indicates all-port listening is enabled.
    protocol String
    Listener protocol type: TCP, UDP, TLS
    securityPolicyId String
    TLS security policy ID. Supports both system security policies and custom security policies. System security policy values: .tlscipherpolicy10 .tlscipherpolicy11 .tlscipherpolicy12 .tlscipherpolicy12strict .tlscipherpolicy12strictwith1_3. For custom security policies, enter the custom security policy ID. This parameter is required when Protocol is TLS.
    serverGroupId String
    Server group ID associated with the listener
    startPort Number
    Start port for all-port listening. Valid only when Port is 0.
    status String
    Listener status
    tags List<Property Map>
    Resource tags
    updatedTime String
    Listener's most recent operation time

    Supporting Types

    GetNlbListenerHealth

    InstanceId string
    Backend server instance ID or IP address
    Ip string
    Backend server IP address
    Port int
    Port on which the backend server provides services
    ServerId string
    Backend server ID
    ServerType string
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    Status string
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    UpdatedTime string
    Last update time of health status
    ZoneId string
    Zone ID where the backend server receives traffic
    InstanceId string
    Backend server instance ID or IP address
    Ip string
    Backend server IP address
    Port int
    Port on which the backend server provides services
    ServerId string
    Backend server ID
    ServerType string
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    Status string
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    UpdatedTime string
    Last update time of health status
    ZoneId string
    Zone ID where the backend server receives traffic
    instanceId String
    Backend server instance ID or IP address
    ip String
    Backend server IP address
    port Integer
    Port on which the backend server provides services
    serverId String
    Backend server ID
    serverType String
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    status String
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    updatedTime String
    Last update time of health status
    zoneId String
    Zone ID where the backend server receives traffic
    instanceId string
    Backend server instance ID or IP address
    ip string
    Backend server IP address
    port number
    Port on which the backend server provides services
    serverId string
    Backend server ID
    serverType string
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    status string
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    updatedTime string
    Last update time of health status
    zoneId string
    Zone ID where the backend server receives traffic
    instance_id str
    Backend server instance ID or IP address
    ip str
    Backend server IP address
    port int
    Port on which the backend server provides services
    server_id str
    Backend server ID
    server_type str
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    status str
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    updated_time str
    Last update time of health status
    zone_id str
    Zone ID where the backend server receives traffic
    instanceId String
    Backend server instance ID or IP address
    ip String
    Backend server IP address
    port Number
    Port on which the backend server provides services
    serverId String
    Backend server ID
    serverType String
    Backend server type: ecs (cloud server instance, i.e., primary network interface); eni (secondary network interface); ip (IP address)
    status String
    Backend server health status: Up (normal); Down (abnormal); Unused (not in use—NLB instance has disabled cross-zone forwarding and there is no traffic from this backend server's zone)
    updatedTime String
    Last update time of health status
    zoneId String
    Zone ID where the backend server receives traffic

    GetNlbListenerTag

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.