volcenginecc v0.0.2, Oct 11 25

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

volcenginecc.clb.getNlbListener

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

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监听器服务器证书的ID，仅支持传入火山引擎证书中心 SSL 证书。。
ConnectionTimeout int: 监听器的连接超时时间（秒）。
CreatedTime string: 监听器的创建时间。
Description string: 监听器描述信息。
Enabled bool: 是否启用监听器。true：开启；false：关闭。
EndPort int: 全端口监听的结束端口，仅当Port为0时有效。
Healths List<Volcengine.GetNlbListenerHealth>: 后端实例健康检查响应信息。
Id string: Uniquely identifies the resource.
ListenerId string: 监听器唯一标识。
ListenerName string: 监听器名称。
LoadBalancerId string: 负载均衡实例ID。
Port int: 监听器接收请求的端口，0表示启用全端口监听。
Protocol string: 监听协议类型。
SecurityPolicyId string: TLS 安全策略ID，支持系统安全策略和自定义安全策略。系统安全策略取值：.tlscipherpolicy10.tlscipherpolicy11.tlscipherpolicy12.tlscipherpolicy12strict.tlscipherpolicy12strictwith1_3.自定义安全策略：输入自定义安全策略 ID。当Protocol为TLS 时，该参数为必填。。
ServerGroupId string: 监听器关联的服务器组ID。
StartPort int: 全端口监听的起始端口，仅当Port为0时有效。
Status string: 监听器的状态。
Tags List<Volcengine.GetNlbListenerTag>: 资源标签。
UpdatedTime string: 监听器最近操作时间。

CertificateId string: TLS监听器服务器证书的ID，仅支持传入火山引擎证书中心 SSL 证书。。
ConnectionTimeout int: 监听器的连接超时时间（秒）。
CreatedTime string: 监听器的创建时间。
Description string: 监听器描述信息。
Enabled bool: 是否启用监听器。true：开启；false：关闭。
EndPort int: 全端口监听的结束端口，仅当Port为0时有效。
Healths []GetNlbListenerHealth: 后端实例健康检查响应信息。
Id string: Uniquely identifies the resource.
ListenerId string: 监听器唯一标识。
ListenerName string: 监听器名称。
LoadBalancerId string: 负载均衡实例ID。
Port int: 监听器接收请求的端口，0表示启用全端口监听。
Protocol string: 监听协议类型。
SecurityPolicyId string: TLS 安全策略ID，支持系统安全策略和自定义安全策略。系统安全策略取值：.tlscipherpolicy10.tlscipherpolicy11.tlscipherpolicy12.tlscipherpolicy12strict.tlscipherpolicy12strictwith1_3.自定义安全策略：输入自定义安全策略 ID。当Protocol为TLS 时，该参数为必填。。
ServerGroupId string: 监听器关联的服务器组ID。
StartPort int: 全端口监听的起始端口，仅当Port为0时有效。
Status string: 监听器的状态。
Tags []GetNlbListenerTag: 资源标签。
UpdatedTime string: 监听器最近操作时间。

certificateId String: TLS监听器服务器证书的ID，仅支持传入火山引擎证书中心 SSL 证书。。
connectionTimeout Integer: 监听器的连接超时时间（秒）。
createdTime String: 监听器的创建时间。
description String: 监听器描述信息。
enabled Boolean: 是否启用监听器。true：开启；false：关闭。
endPort Integer: 全端口监听的结束端口，仅当Port为0时有效。
healths List<GetNlbListenerHealth>: 后端实例健康检查响应信息。
id String: Uniquely identifies the resource.
listenerId String: 监听器唯一标识。
listenerName String: 监听器名称。
loadBalancerId String: 负载均衡实例ID。
port Integer: 监听器接收请求的端口，0表示启用全端口监听。
protocol String: 监听协议类型。
securityPolicyId String: TLS 安全策略ID，支持系统安全策略和自定义安全策略。系统安全策略取值：.tlscipherpolicy10.tlscipherpolicy11.tlscipherpolicy12.tlscipherpolicy12strict.tlscipherpolicy12strictwith1_3.自定义安全策略：输入自定义安全策略 ID。当Protocol为TLS 时，该参数为必填。。
serverGroupId String: 监听器关联的服务器组ID。
startPort Integer: 全端口监听的起始端口，仅当Port为0时有效。
status String: 监听器的状态。
tags List<GetNlbListenerTag>: 资源标签。
updatedTime String: 监听器最近操作时间。

certificateId string: TLS监听器服务器证书的ID，仅支持传入火山引擎证书中心 SSL 证书。。
connectionTimeout number: 监听器的连接超时时间（秒）。
createdTime string: 监听器的创建时间。
description string: 监听器描述信息。
enabled boolean: 是否启用监听器。true：开启；false：关闭。
endPort number: 全端口监听的结束端口，仅当Port为0时有效。
healths GetNlbListenerHealth[]: 后端实例健康检查响应信息。
id string: Uniquely identifies the resource.
listenerId string: 监听器唯一标识。
listenerName string: 监听器名称。
loadBalancerId string: 负载均衡实例ID。
port number: 监听器接收请求的端口，0表示启用全端口监听。
protocol string: 监听协议类型。
securityPolicyId string: TLS 安全策略ID，支持系统安全策略和自定义安全策略。系统安全策略取值：.tlscipherpolicy10.tlscipherpolicy11.tlscipherpolicy12.tlscipherpolicy12strict.tlscipherpolicy12strictwith1_3.自定义安全策略：输入自定义安全策略 ID。当Protocol为TLS 时，该参数为必填。。
serverGroupId string: 监听器关联的服务器组ID。
startPort number: 全端口监听的起始端口，仅当Port为0时有效。
status string: 监听器的状态。
tags GetNlbListenerTag[]: 资源标签。
updatedTime string: 监听器最近操作时间。

certificate_id str: TLS监听器服务器证书的ID，仅支持传入火山引擎证书中心 SSL 证书。。
connection_timeout int: 监听器的连接超时时间（秒）。
created_time str: 监听器的创建时间。
description str: 监听器描述信息。
enabled bool: 是否启用监听器。true：开启；false：关闭。
end_port int: 全端口监听的结束端口，仅当Port为0时有效。
healths Sequence[GetNlbListenerHealth]: 后端实例健康检查响应信息。
id str: Uniquely identifies the resource.
listener_id str: 监听器唯一标识。
listener_name str: 监听器名称。
load_balancer_id str: 负载均衡实例ID。
port int: 监听器接收请求的端口，0表示启用全端口监听。
protocol str: 监听协议类型。
security_policy_id str: TLS 安全策略ID，支持系统安全策略和自定义安全策略。系统安全策略取值：.tlscipherpolicy10.tlscipherpolicy11.tlscipherpolicy12.tlscipherpolicy12strict.tlscipherpolicy12strictwith1_3.自定义安全策略：输入自定义安全策略 ID。当Protocol为TLS 时，该参数为必填。。
server_group_id str: 监听器关联的服务器组ID。
start_port int: 全端口监听的起始端口，仅当Port为0时有效。
status str: 监听器的状态。
tags Sequence[GetNlbListenerTag]: 资源标签。
updated_time str: 监听器最近操作时间。

certificateId String: TLS监听器服务器证书的ID，仅支持传入火山引擎证书中心 SSL 证书。。
connectionTimeout Number: 监听器的连接超时时间（秒）。
createdTime String: 监听器的创建时间。
description String: 监听器描述信息。
enabled Boolean: 是否启用监听器。true：开启；false：关闭。
endPort Number: 全端口监听的结束端口，仅当Port为0时有效。
healths List<Property Map>: 后端实例健康检查响应信息。
id String: Uniquely identifies the resource.
listenerId String: 监听器唯一标识。
listenerName String: 监听器名称。
loadBalancerId String: 负载均衡实例ID。
port Number: 监听器接收请求的端口，0表示启用全端口监听。
protocol String: 监听协议类型。
securityPolicyId String: TLS 安全策略ID，支持系统安全策略和自定义安全策略。系统安全策略取值：.tlscipherpolicy10.tlscipherpolicy11.tlscipherpolicy12.tlscipherpolicy12strict.tlscipherpolicy12strictwith1_3.自定义安全策略：输入自定义安全策略 ID。当Protocol为TLS 时，该参数为必填。。
serverGroupId String: 监听器关联的服务器组ID。
startPort Number: 全端口监听的起始端口，仅当Port为0时有效。
status String: 监听器的状态。
tags List<Property Map>: 资源标签。
updatedTime String: 监听器最近操作时间。

Supporting Types

GetNlbListenerHealth

InstanceId string: 后端服务器的实例 ID或IP地址。
Ip string: 后端服务器的IP地址。
Port int: 后端服务器提供服务的端口。
ServerId string: 后端服务器ID。
ServerType string: 后端服务器的类型。ecs：云服务器实例（即主网卡）；eni：辅助网卡；ip：IP地址
Status string: 后端服务器的健康状态。Up：正常；Down：异常；Unused：未被使用（NLB实例已关闭跨可用区转发，且没有来自该后端服务器可用区的访问流量）。
UpdatedTime string: 健康状态最后更新时间。
ZoneId string: 后端服务器接收访问流量的可用区ID。

InstanceId string: 后端服务器的实例 ID或IP地址。
Ip string: 后端服务器的IP地址。
Port int: 后端服务器提供服务的端口。
ServerId string: 后端服务器ID。
ServerType string: 后端服务器的类型。ecs：云服务器实例（即主网卡）；eni：辅助网卡；ip：IP地址
Status string: 后端服务器的健康状态。Up：正常；Down：异常；Unused：未被使用（NLB实例已关闭跨可用区转发，且没有来自该后端服务器可用区的访问流量）。
UpdatedTime string: 健康状态最后更新时间。
ZoneId string: 后端服务器接收访问流量的可用区ID。

instanceId String: 后端服务器的实例 ID或IP地址。
ip String: 后端服务器的IP地址。
port Integer: 后端服务器提供服务的端口。
serverId String: 后端服务器ID。
serverType String: 后端服务器的类型。ecs：云服务器实例（即主网卡）；eni：辅助网卡；ip：IP地址
status String: 后端服务器的健康状态。Up：正常；Down：异常；Unused：未被使用（NLB实例已关闭跨可用区转发，且没有来自该后端服务器可用区的访问流量）。
updatedTime String: 健康状态最后更新时间。
zoneId String: 后端服务器接收访问流量的可用区ID。

instanceId string: 后端服务器的实例 ID或IP地址。
ip string: 后端服务器的IP地址。
port number: 后端服务器提供服务的端口。
serverId string: 后端服务器ID。
serverType string: 后端服务器的类型。ecs：云服务器实例（即主网卡）；eni：辅助网卡；ip：IP地址
status string: 后端服务器的健康状态。Up：正常；Down：异常；Unused：未被使用（NLB实例已关闭跨可用区转发，且没有来自该后端服务器可用区的访问流量）。
updatedTime string: 健康状态最后更新时间。
zoneId string: 后端服务器接收访问流量的可用区ID。

instance_id str: 后端服务器的实例 ID或IP地址。
ip str: 后端服务器的IP地址。
port int: 后端服务器提供服务的端口。
server_id str: 后端服务器ID。
server_type str: 后端服务器的类型。ecs：云服务器实例（即主网卡）；eni：辅助网卡；ip：IP地址
status str: 后端服务器的健康状态。Up：正常；Down：异常；Unused：未被使用（NLB实例已关闭跨可用区转发，且没有来自该后端服务器可用区的访问流量）。
updated_time str: 健康状态最后更新时间。
zone_id str: 后端服务器接收访问流量的可用区ID。

instanceId String: 后端服务器的实例 ID或IP地址。
ip String: 后端服务器的IP地址。
port Number: 后端服务器提供服务的端口。
serverId String: 后端服务器ID。
serverType String: 后端服务器的类型。ecs：云服务器实例（即主网卡）；eni：辅助网卡；ip：IP地址
status String: 后端服务器的健康状态。Up：正常；Down：异常；Unused：未被使用（NLB实例已关闭跨可用区转发，且没有来自该后端服务器可用区的访问流量）。
updatedTime String: 健康状态最后更新时间。
zoneId String: 后端服务器接收访问流量的可用区ID。

GetNlbListenerTag

Key string: 标签键。
Value string: 标签值。

Key string: 标签键。
Value string: 标签值。

key String: 标签键。
value String: 标签值。

key string: 标签键。
value string: 标签值。

key str: 标签键。
value str: 标签值。

key String: 标签键。
value String: 标签值。

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

volcengine/pulumi-volcenginecc

volcenginecc.clb.getNlbListener

On this page

On this page

Using getNlbListener

getNlbListener Result

Supporting Types

GetNlbListenerHealth

GetNlbListenerTag

Package Details

On this page

On this page