getNlb

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getNlb

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 getNlb(args: GetNlbArgs, opts?: InvokeOptions): Promise<GetNlbResult>
function getNlbOutput(args: GetNlbOutputArgs, opts?: InvokeOptions): Output<GetNlbResult>

def get_nlb(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetNlbResult
def get_nlb_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetNlbResult]

func LookupNlb(ctx *Context, args *LookupNlbArgs, opts ...InvokeOption) (*LookupNlbResult, error)
func LookupNlbOutput(ctx *Context, args *LookupNlbOutputArgs, opts ...InvokeOption) LookupNlbResultOutput

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

public static class GetNlb 
{
    public static Task<GetNlbResult> InvokeAsync(GetNlbArgs args, InvokeOptions? opts = null)
    public static Output<GetNlbResult> Invoke(GetNlbInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNlbResult> getNlb(GetNlbArgs args, InvokeOptions options)
public static Output<GetNlbResult> getNlb(GetNlbArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:clb/getNlb:getNlb
  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.

getNlb Result

The following output properties are available:

AccountId string: NLB实例所属的账号ID。
BillingStatus string: NLB实例的计费状态。Normal: 正常，FinancialLocked: 被锁定。
BillingType int: NLB实例的计费类型。3：按使用量计费
CreatedTime string: NLB实例的创建时间。
CrossZoneEnabled bool: NLB实例是否开启跨可用区转发能力。true（默认值）：开启。false：关闭。
Description string: NLB实例的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
DnsName string: NLB实例的DNS地址。
ExpectedOverdueTime string: NLB实例欠费关停时间。
Id string: Uniquely identifies the resource.
IpAddressVersion string: NLB实例的IP地址类型。ipv4：IPv4版本。dualstack：双栈，即同时支持IPv4版本和IPv6版本。
Ipv4BandwidthPackageId string: IPv4类型的共享带宽包ID。
Ipv4NetworkType string: NLB实例的IPv4网络类型。internet：公网类型。intranet：私网类型。
Ipv6BandwidthPackageId string: IPv6类型的共享带宽包ID。
Ipv6NetworkType string: NLB实例的IPv6网络类型。internet：公网类型。intranet：私网类型。
LoadBalancerId string: NLB实例ID。
LoadBalancerName string: NLB实例的名称。
ManagedSecurityGroupId string: 系统为NLB实例自动关联的托管安全组ID。
ModificationProtectionStatus string: NLB实例是否开启控制台上修改保护。NonProtection或空：关闭，允许通过控制台修改实例或删除实例。ConsoleProtection：开启，禁止通过控制台修改实例或删除实例。
OverdueTime string: NLB实例被锁定的时间。参数BillingStatus为Normal时，本参数返回为空字符串。
ProjectName string: NLB实例所属项目的名称。
ReclaimedTime string: NLB实例的预期回收时间。参数BillingStatus为Normal时，本参数返回为空字符串。
SecurityGroupIds List<string>: NLB实例关联的安全组ID列表。
Status string: NLB 实例的状态。Inactive：已停止。Active：运行中。Creating：创建中。Provisioning：创建中。仅调用API创建NLB实例时存在该状态。Configuring：配置中。Deleting：删除中。CreateFailed：创建失败。
Tags List<Byteplus.GetNlbTag>: NLB实例的标签信息。
UpdatedTime string: NLB实例的更新时间。
VpcId string: NLB实例所属的VPC ID。
ZoneMappings List<Byteplus.GetNlbZoneMapping>: NLB实例的可用区信息。

AccountId string: NLB实例所属的账号ID。
BillingStatus string: NLB实例的计费状态。Normal: 正常，FinancialLocked: 被锁定。
BillingType int: NLB实例的计费类型。3：按使用量计费
CreatedTime string: NLB实例的创建时间。
CrossZoneEnabled bool: NLB实例是否开启跨可用区转发能力。true（默认值）：开启。false：关闭。
Description string: NLB实例的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
DnsName string: NLB实例的DNS地址。
ExpectedOverdueTime string: NLB实例欠费关停时间。
Id string: Uniquely identifies the resource.
IpAddressVersion string: NLB实例的IP地址类型。ipv4：IPv4版本。dualstack：双栈，即同时支持IPv4版本和IPv6版本。
Ipv4BandwidthPackageId string: IPv4类型的共享带宽包ID。
Ipv4NetworkType string: NLB实例的IPv4网络类型。internet：公网类型。intranet：私网类型。
Ipv6BandwidthPackageId string: IPv6类型的共享带宽包ID。
Ipv6NetworkType string: NLB实例的IPv6网络类型。internet：公网类型。intranet：私网类型。
LoadBalancerId string: NLB实例ID。
LoadBalancerName string: NLB实例的名称。
ManagedSecurityGroupId string: 系统为NLB实例自动关联的托管安全组ID。
ModificationProtectionStatus string: NLB实例是否开启控制台上修改保护。NonProtection或空：关闭，允许通过控制台修改实例或删除实例。ConsoleProtection：开启，禁止通过控制台修改实例或删除实例。
OverdueTime string: NLB实例被锁定的时间。参数BillingStatus为Normal时，本参数返回为空字符串。
ProjectName string: NLB实例所属项目的名称。
ReclaimedTime string: NLB实例的预期回收时间。参数BillingStatus为Normal时，本参数返回为空字符串。
SecurityGroupIds []string: NLB实例关联的安全组ID列表。
Status string: NLB 实例的状态。Inactive：已停止。Active：运行中。Creating：创建中。Provisioning：创建中。仅调用API创建NLB实例时存在该状态。Configuring：配置中。Deleting：删除中。CreateFailed：创建失败。
Tags []GetNlbTag: NLB实例的标签信息。
UpdatedTime string: NLB实例的更新时间。
VpcId string: NLB实例所属的VPC ID。
ZoneMappings []GetNlbZoneMapping: NLB实例的可用区信息。

accountId String: NLB实例所属的账号ID。
billingStatus String: NLB实例的计费状态。Normal: 正常，FinancialLocked: 被锁定。
billingType Integer: NLB实例的计费类型。3：按使用量计费
createdTime String: NLB实例的创建时间。
crossZoneEnabled Boolean: NLB实例是否开启跨可用区转发能力。true（默认值）：开启。false：关闭。
description String: NLB实例的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
dnsName String: NLB实例的DNS地址。
expectedOverdueTime String: NLB实例欠费关停时间。
id String: Uniquely identifies the resource.
ipAddressVersion String: NLB实例的IP地址类型。ipv4：IPv4版本。dualstack：双栈，即同时支持IPv4版本和IPv6版本。
ipv4BandwidthPackageId String: IPv4类型的共享带宽包ID。
ipv4NetworkType String: NLB实例的IPv4网络类型。internet：公网类型。intranet：私网类型。
ipv6BandwidthPackageId String: IPv6类型的共享带宽包ID。
ipv6NetworkType String: NLB实例的IPv6网络类型。internet：公网类型。intranet：私网类型。
loadBalancerId String: NLB实例ID。
loadBalancerName String: NLB实例的名称。
managedSecurityGroupId String: 系统为NLB实例自动关联的托管安全组ID。
modificationProtectionStatus String: NLB实例是否开启控制台上修改保护。NonProtection或空：关闭，允许通过控制台修改实例或删除实例。ConsoleProtection：开启，禁止通过控制台修改实例或删除实例。
overdueTime String: NLB实例被锁定的时间。参数BillingStatus为Normal时，本参数返回为空字符串。
projectName String: NLB实例所属项目的名称。
reclaimedTime String: NLB实例的预期回收时间。参数BillingStatus为Normal时，本参数返回为空字符串。
securityGroupIds List<String>: NLB实例关联的安全组ID列表。
status String: NLB 实例的状态。Inactive：已停止。Active：运行中。Creating：创建中。Provisioning：创建中。仅调用API创建NLB实例时存在该状态。Configuring：配置中。Deleting：删除中。CreateFailed：创建失败。
tags List<GetNlbTag>: NLB实例的标签信息。
updatedTime String: NLB实例的更新时间。
vpcId String: NLB实例所属的VPC ID。
zoneMappings List<GetNlbZoneMapping>: NLB实例的可用区信息。

accountId string: NLB实例所属的账号ID。
billingStatus string: NLB实例的计费状态。Normal: 正常，FinancialLocked: 被锁定。
billingType number: NLB实例的计费类型。3：按使用量计费
createdTime string: NLB实例的创建时间。
crossZoneEnabled boolean: NLB实例是否开启跨可用区转发能力。true（默认值）：开启。false：关闭。
description string: NLB实例的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
dnsName string: NLB实例的DNS地址。
expectedOverdueTime string: NLB实例欠费关停时间。
id string: Uniquely identifies the resource.
ipAddressVersion string: NLB实例的IP地址类型。ipv4：IPv4版本。dualstack：双栈，即同时支持IPv4版本和IPv6版本。
ipv4BandwidthPackageId string: IPv4类型的共享带宽包ID。
ipv4NetworkType string: NLB实例的IPv4网络类型。internet：公网类型。intranet：私网类型。
ipv6BandwidthPackageId string: IPv6类型的共享带宽包ID。
ipv6NetworkType string: NLB实例的IPv6网络类型。internet：公网类型。intranet：私网类型。
loadBalancerId string: NLB实例ID。
loadBalancerName string: NLB实例的名称。
managedSecurityGroupId string: 系统为NLB实例自动关联的托管安全组ID。
modificationProtectionStatus string: NLB实例是否开启控制台上修改保护。NonProtection或空：关闭，允许通过控制台修改实例或删除实例。ConsoleProtection：开启，禁止通过控制台修改实例或删除实例。
overdueTime string: NLB实例被锁定的时间。参数BillingStatus为Normal时，本参数返回为空字符串。
projectName string: NLB实例所属项目的名称。
reclaimedTime string: NLB实例的预期回收时间。参数BillingStatus为Normal时，本参数返回为空字符串。
securityGroupIds string[]: NLB实例关联的安全组ID列表。
status string: NLB 实例的状态。Inactive：已停止。Active：运行中。Creating：创建中。Provisioning：创建中。仅调用API创建NLB实例时存在该状态。Configuring：配置中。Deleting：删除中。CreateFailed：创建失败。
tags GetNlbTag[]: NLB实例的标签信息。
updatedTime string: NLB实例的更新时间。
vpcId string: NLB实例所属的VPC ID。
zoneMappings GetNlbZoneMapping[]: NLB实例的可用区信息。

account_id str: NLB实例所属的账号ID。
billing_status str: NLB实例的计费状态。Normal: 正常，FinancialLocked: 被锁定。
billing_type int: NLB实例的计费类型。3：按使用量计费
created_time str: NLB实例的创建时间。
cross_zone_enabled bool: NLB实例是否开启跨可用区转发能力。true（默认值）：开启。false：关闭。
description str: NLB实例的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
dns_name str: NLB实例的DNS地址。
expected_overdue_time str: NLB实例欠费关停时间。
id str: Uniquely identifies the resource.
ip_address_version str: NLB实例的IP地址类型。ipv4：IPv4版本。dualstack：双栈，即同时支持IPv4版本和IPv6版本。
ipv4_bandwidth_package_id str: IPv4类型的共享带宽包ID。
ipv4_network_type str: NLB实例的IPv4网络类型。internet：公网类型。intranet：私网类型。
ipv6_bandwidth_package_id str: IPv6类型的共享带宽包ID。
ipv6_network_type str: NLB实例的IPv6网络类型。internet：公网类型。intranet：私网类型。
load_balancer_id str: NLB实例ID。
load_balancer_name str: NLB实例的名称。
managed_security_group_id str: 系统为NLB实例自动关联的托管安全组ID。
modification_protection_status str: NLB实例是否开启控制台上修改保护。NonProtection或空：关闭，允许通过控制台修改实例或删除实例。ConsoleProtection：开启，禁止通过控制台修改实例或删除实例。
overdue_time str: NLB实例被锁定的时间。参数BillingStatus为Normal时，本参数返回为空字符串。
project_name str: NLB实例所属项目的名称。
reclaimed_time str: NLB实例的预期回收时间。参数BillingStatus为Normal时，本参数返回为空字符串。
security_group_ids Sequence[str]: NLB实例关联的安全组ID列表。
status str: NLB 实例的状态。Inactive：已停止。Active：运行中。Creating：创建中。Provisioning：创建中。仅调用API创建NLB实例时存在该状态。Configuring：配置中。Deleting：删除中。CreateFailed：创建失败。
tags Sequence[GetNlbTag]: NLB实例的标签信息。
updated_time str: NLB实例的更新时间。
vpc_id str: NLB实例所属的VPC ID。
zone_mappings Sequence[GetNlbZoneMapping]: NLB实例的可用区信息。

accountId String: NLB实例所属的账号ID。
billingStatus String: NLB实例的计费状态。Normal: 正常，FinancialLocked: 被锁定。
billingType Number: NLB实例的计费类型。3：按使用量计费
createdTime String: NLB实例的创建时间。
crossZoneEnabled Boolean: NLB实例是否开启跨可用区转发能力。true（默认值）：开启。false：关闭。
description String: NLB实例的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
dnsName String: NLB实例的DNS地址。
expectedOverdueTime String: NLB实例欠费关停时间。
id String: Uniquely identifies the resource.
ipAddressVersion String: NLB实例的IP地址类型。ipv4：IPv4版本。dualstack：双栈，即同时支持IPv4版本和IPv6版本。
ipv4BandwidthPackageId String: IPv4类型的共享带宽包ID。
ipv4NetworkType String: NLB实例的IPv4网络类型。internet：公网类型。intranet：私网类型。
ipv6BandwidthPackageId String: IPv6类型的共享带宽包ID。
ipv6NetworkType String: NLB实例的IPv6网络类型。internet：公网类型。intranet：私网类型。
loadBalancerId String: NLB实例ID。
loadBalancerName String: NLB实例的名称。
managedSecurityGroupId String: 系统为NLB实例自动关联的托管安全组ID。
modificationProtectionStatus String: NLB实例是否开启控制台上修改保护。NonProtection或空：关闭，允许通过控制台修改实例或删除实例。ConsoleProtection：开启，禁止通过控制台修改实例或删除实例。
overdueTime String: NLB实例被锁定的时间。参数BillingStatus为Normal时，本参数返回为空字符串。
projectName String: NLB实例所属项目的名称。
reclaimedTime String: NLB实例的预期回收时间。参数BillingStatus为Normal时，本参数返回为空字符串。
securityGroupIds List<String>: NLB实例关联的安全组ID列表。
status String: NLB 实例的状态。Inactive：已停止。Active：运行中。Creating：创建中。Provisioning：创建中。仅调用API创建NLB实例时存在该状态。Configuring：配置中。Deleting：删除中。CreateFailed：创建失败。
tags List<Property Map>: NLB实例的标签信息。
updatedTime String: NLB实例的更新时间。
vpcId String: NLB实例所属的VPC ID。
zoneMappings List<Property Map>: NLB实例的可用区信息。

Supporting Types

GetNlbTag

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

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

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

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

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

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

GetNlbZoneMapping

EniId string: 网卡ID。
Ipv4Address string: NLB实例的私网IPv4 VIP地址。该参数不传入，则系统自动从子网中分配一个可用的IPv4地址。
Ipv4EipAddress string: NLB实例的公网IPv4 EIP地址。
Ipv4EipId string: NLB实例的公网IPv4 EIP ID。
Ipv4HcStatus string: NLB实例私网IPv4地址的健康状态。Healthy：健康。Unhealthy：异常。
Ipv4LocalAddresses List<string>: NLB实例的私网IPv4 LIP地址。
Ipv6Address string: NLB实例的私网IPv6 VIP地址。
Ipv6EipId string: NLB实例关联的IPv6公网带宽的ID。
Ipv6HcStatus string: NLB实例私网IPv6地址的健康状态。Healthy：健康。Unhealthy：异常。
Ipv6LocalAddresses List<string>: NLB实例的私网IPv6 LIP地址。
SubnetId string: NLB实例所属的子网ID。
ZoneId string: NLB实例所属的可用区ID。

EniId string: 网卡ID。
Ipv4Address string: NLB实例的私网IPv4 VIP地址。该参数不传入，则系统自动从子网中分配一个可用的IPv4地址。
Ipv4EipAddress string: NLB实例的公网IPv4 EIP地址。
Ipv4EipId string: NLB实例的公网IPv4 EIP ID。
Ipv4HcStatus string: NLB实例私网IPv4地址的健康状态。Healthy：健康。Unhealthy：异常。
Ipv4LocalAddresses []string: NLB实例的私网IPv4 LIP地址。
Ipv6Address string: NLB实例的私网IPv6 VIP地址。
Ipv6EipId string: NLB实例关联的IPv6公网带宽的ID。
Ipv6HcStatus string: NLB实例私网IPv6地址的健康状态。Healthy：健康。Unhealthy：异常。
Ipv6LocalAddresses []string: NLB实例的私网IPv6 LIP地址。
SubnetId string: NLB实例所属的子网ID。
ZoneId string: NLB实例所属的可用区ID。

eniId String: 网卡ID。
ipv4Address String: NLB实例的私网IPv4 VIP地址。该参数不传入，则系统自动从子网中分配一个可用的IPv4地址。
ipv4EipAddress String: NLB实例的公网IPv4 EIP地址。
ipv4EipId String: NLB实例的公网IPv4 EIP ID。
ipv4HcStatus String: NLB实例私网IPv4地址的健康状态。Healthy：健康。Unhealthy：异常。
ipv4LocalAddresses List<String>: NLB实例的私网IPv4 LIP地址。
ipv6Address String: NLB实例的私网IPv6 VIP地址。
ipv6EipId String: NLB实例关联的IPv6公网带宽的ID。
ipv6HcStatus String: NLB实例私网IPv6地址的健康状态。Healthy：健康。Unhealthy：异常。
ipv6LocalAddresses List<String>: NLB实例的私网IPv6 LIP地址。
subnetId String: NLB实例所属的子网ID。
zoneId String: NLB实例所属的可用区ID。

eniId string: 网卡ID。
ipv4Address string: NLB实例的私网IPv4 VIP地址。该参数不传入，则系统自动从子网中分配一个可用的IPv4地址。
ipv4EipAddress string: NLB实例的公网IPv4 EIP地址。
ipv4EipId string: NLB实例的公网IPv4 EIP ID。
ipv4HcStatus string: NLB实例私网IPv4地址的健康状态。Healthy：健康。Unhealthy：异常。
ipv4LocalAddresses string[]: NLB实例的私网IPv4 LIP地址。
ipv6Address string: NLB实例的私网IPv6 VIP地址。
ipv6EipId string: NLB实例关联的IPv6公网带宽的ID。
ipv6HcStatus string: NLB实例私网IPv6地址的健康状态。Healthy：健康。Unhealthy：异常。
ipv6LocalAddresses string[]: NLB实例的私网IPv6 LIP地址。
subnetId string: NLB实例所属的子网ID。
zoneId string: NLB实例所属的可用区ID。

eni_id str: 网卡ID。
ipv4_address str: NLB实例的私网IPv4 VIP地址。该参数不传入，则系统自动从子网中分配一个可用的IPv4地址。
ipv4_eip_address str: NLB实例的公网IPv4 EIP地址。
ipv4_eip_id str: NLB实例的公网IPv4 EIP ID。
ipv4_hc_status str: NLB实例私网IPv4地址的健康状态。Healthy：健康。Unhealthy：异常。
ipv4_local_addresses Sequence[str]: NLB实例的私网IPv4 LIP地址。
ipv6_address str: NLB实例的私网IPv6 VIP地址。
ipv6_eip_id str: NLB实例关联的IPv6公网带宽的ID。
ipv6_hc_status str: NLB实例私网IPv6地址的健康状态。Healthy：健康。Unhealthy：异常。
ipv6_local_addresses Sequence[str]: NLB实例的私网IPv6 LIP地址。
subnet_id str: NLB实例所属的子网ID。
zone_id str: NLB实例所属的可用区ID。

eniId String: 网卡ID。
ipv4Address String: NLB实例的私网IPv4 VIP地址。该参数不传入，则系统自动从子网中分配一个可用的IPv4地址。
ipv4EipAddress String: NLB实例的公网IPv4 EIP地址。
ipv4EipId String: NLB实例的公网IPv4 EIP ID。
ipv4HcStatus String: NLB实例私网IPv4地址的健康状态。Healthy：健康。Unhealthy：异常。
ipv4LocalAddresses List<String>: NLB实例的私网IPv4 LIP地址。
ipv6Address String: NLB实例的私网IPv6 VIP地址。
ipv6EipId String: NLB实例关联的IPv6公网带宽的ID。
ipv6HcStatus String: NLB实例私网IPv6地址的健康状态。Healthy：健康。Unhealthy：异常。
ipv6LocalAddresses List<String>: NLB实例的私网IPv6 LIP地址。
subnetId String: NLB实例所属的子网ID。
zoneId String: NLB实例所属的可用区ID。

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.clb.getNlb

On this page

On this page

Using getNlb

getNlb Result

Supporting Types

GetNlbTag

GetNlbZoneMapping

Package Details

On this page

On this page