bytepluscc.clb.getNlbServerGroup

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 getNlbServerGroup

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 getNlbServerGroup(args: GetNlbServerGroupArgs, opts?: InvokeOptions): Promise<GetNlbServerGroupResult>
function getNlbServerGroupOutput(args: GetNlbServerGroupOutputArgs, opts?: InvokeOptions): Output<GetNlbServerGroupResult>

def get_nlb_server_group(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetNlbServerGroupResult
def get_nlb_server_group_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetNlbServerGroupResult]

func LookupNlbServerGroup(ctx *Context, args *LookupNlbServerGroupArgs, opts ...InvokeOption) (*LookupNlbServerGroupResult, error)
func LookupNlbServerGroupOutput(ctx *Context, args *LookupNlbServerGroupOutputArgs, opts ...InvokeOption) LookupNlbServerGroupResultOutput

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

public static class GetNlbServerGroup 
{
    public static Task<GetNlbServerGroupResult> InvokeAsync(GetNlbServerGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetNlbServerGroupResult> Invoke(GetNlbServerGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNlbServerGroupResult> getNlbServerGroup(GetNlbServerGroupArgs args, InvokeOptions options)
public static Output<GetNlbServerGroupResult> getNlbServerGroup(GetNlbServerGroupArgs args, InvokeOptions options)

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

getNlbServerGroup Result

The following output properties are available:

AccountId string: 账号ID。
AnyPortEnabled bool: 是否开启全端口转发。
BypassSecurityGroupEnabled bool: 是否开启放通后端安全组功能。仅参数Type为“instance”时，可以配置此参数。
ConnectionDrainEnabled bool: 是否开启连接优雅中断。
ConnectionDrainTimeout int: 连接优雅中断超时时间，取值范围为0～900秒。参数ConnectionDrainEnabled为“true”时，该参数为必填。
CreatedTime string: 后端服务器组的创建时间。
Description string: 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
HealthCheck Byteplus.GetNlbServerGroupHealthCheck: 健康检查相关参数。
Id string: Uniquely identifies the resource.
IpAddressVersion string: 服务器组的IP地址类型。取值如下：ipv4（默认值）：表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6：表示该服务器组仅支持添加IPv6类型的后端服务器。
PreserveClientIpEnabled bool: 是否开启源地址保持。
ProjectName string: 项目名称。
Protocol string: NLB转发流量到后端服务器时使用的通信协议。取值如下：TCP。UDP。
ProxyProtocolType string: 是否开启Proxy-Protocol协议。取值如下：off（默认值）：关闭。standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器，还需要在后端服务器上配置Proxy-Protocol。
RelatedLoadBalancerIds List<string>: 服务器组关联的NLB实例。
Scheduler string: NLB转发流量时遵循的规则。取值如下：wrr（默认值）：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。wlc：加权最小连接数，在最少连接数的基础上，根据后端服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。
ServerCount int: 服务器组中后端服务器的数量。
ServerGroupId string: 服务器组ID。
ServerGroupName string: 服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
Servers List<Byteplus.GetNlbServerGroupServer>: 服务器组中待添加后端服务器的信息。
SessionPersistenceEnabled bool: 是否开启会话保持。
SessionPersistenceTimeout int: 会话保持的超时时间，取值范围为1～3600秒，默认1000秒。
Status string: 服务器组的状态。
Tags List<Byteplus.GetNlbServerGroupTag>: 标签。
TimestampRemoveEnabled bool: 是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。
Type string: 服务器组的类型。取值如下：instance（默认值）：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
UpdatedTime string: 后端服务器组的更新时间。
VpcId string: 服务器组所属私有网络的ID。

AccountId string: 账号ID。
AnyPortEnabled bool: 是否开启全端口转发。
BypassSecurityGroupEnabled bool: 是否开启放通后端安全组功能。仅参数Type为“instance”时，可以配置此参数。
ConnectionDrainEnabled bool: 是否开启连接优雅中断。
ConnectionDrainTimeout int: 连接优雅中断超时时间，取值范围为0～900秒。参数ConnectionDrainEnabled为“true”时，该参数为必填。
CreatedTime string: 后端服务器组的创建时间。
Description string: 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
HealthCheck GetNlbServerGroupHealthCheck: 健康检查相关参数。
Id string: Uniquely identifies the resource.
IpAddressVersion string: 服务器组的IP地址类型。取值如下：ipv4（默认值）：表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6：表示该服务器组仅支持添加IPv6类型的后端服务器。
PreserveClientIpEnabled bool: 是否开启源地址保持。
ProjectName string: 项目名称。
Protocol string: NLB转发流量到后端服务器时使用的通信协议。取值如下：TCP。UDP。
ProxyProtocolType string: 是否开启Proxy-Protocol协议。取值如下：off（默认值）：关闭。standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器，还需要在后端服务器上配置Proxy-Protocol。
RelatedLoadBalancerIds []string: 服务器组关联的NLB实例。
Scheduler string: NLB转发流量时遵循的规则。取值如下：wrr（默认值）：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。wlc：加权最小连接数，在最少连接数的基础上，根据后端服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。
ServerCount int: 服务器组中后端服务器的数量。
ServerGroupId string: 服务器组ID。
ServerGroupName string: 服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
Servers []GetNlbServerGroupServer: 服务器组中待添加后端服务器的信息。
SessionPersistenceEnabled bool: 是否开启会话保持。
SessionPersistenceTimeout int: 会话保持的超时时间，取值范围为1～3600秒，默认1000秒。
Status string: 服务器组的状态。
Tags []GetNlbServerGroupTag: 标签。
TimestampRemoveEnabled bool: 是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。
Type string: 服务器组的类型。取值如下：instance（默认值）：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
UpdatedTime string: 后端服务器组的更新时间。
VpcId string: 服务器组所属私有网络的ID。

accountId String: 账号ID。
anyPortEnabled Boolean: 是否开启全端口转发。
bypassSecurityGroupEnabled Boolean: 是否开启放通后端安全组功能。仅参数Type为“instance”时，可以配置此参数。
connectionDrainEnabled Boolean: 是否开启连接优雅中断。
connectionDrainTimeout Integer: 连接优雅中断超时时间，取值范围为0～900秒。参数ConnectionDrainEnabled为“true”时，该参数为必填。
createdTime String: 后端服务器组的创建时间。
description String: 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
healthCheck GetNlbServerGroupHealthCheck: 健康检查相关参数。
id String: Uniquely identifies the resource.
ipAddressVersion String: 服务器组的IP地址类型。取值如下：ipv4（默认值）：表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6：表示该服务器组仅支持添加IPv6类型的后端服务器。
preserveClientIpEnabled Boolean: 是否开启源地址保持。
projectName String: 项目名称。
protocol String: NLB转发流量到后端服务器时使用的通信协议。取值如下：TCP。UDP。
proxyProtocolType String: 是否开启Proxy-Protocol协议。取值如下：off（默认值）：关闭。standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器，还需要在后端服务器上配置Proxy-Protocol。
relatedLoadBalancerIds List<String>: 服务器组关联的NLB实例。
scheduler String: NLB转发流量时遵循的规则。取值如下：wrr（默认值）：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。wlc：加权最小连接数，在最少连接数的基础上，根据后端服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。
serverCount Integer: 服务器组中后端服务器的数量。
serverGroupId String: 服务器组ID。
serverGroupName String: 服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
servers List<GetNlbServerGroupServer>: 服务器组中待添加后端服务器的信息。
sessionPersistenceEnabled Boolean: 是否开启会话保持。
sessionPersistenceTimeout Integer: 会话保持的超时时间，取值范围为1～3600秒，默认1000秒。
status String: 服务器组的状态。
tags List<GetNlbServerGroupTag>: 标签。
timestampRemoveEnabled Boolean: 是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。
type String: 服务器组的类型。取值如下：instance（默认值）：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
updatedTime String: 后端服务器组的更新时间。
vpcId String: 服务器组所属私有网络的ID。

accountId string: 账号ID。
anyPortEnabled boolean: 是否开启全端口转发。
bypassSecurityGroupEnabled boolean: 是否开启放通后端安全组功能。仅参数Type为“instance”时，可以配置此参数。
connectionDrainEnabled boolean: 是否开启连接优雅中断。
connectionDrainTimeout number: 连接优雅中断超时时间，取值范围为0～900秒。参数ConnectionDrainEnabled为“true”时，该参数为必填。
createdTime string: 后端服务器组的创建时间。
description string: 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
healthCheck GetNlbServerGroupHealthCheck: 健康检查相关参数。
id string: Uniquely identifies the resource.
ipAddressVersion string: 服务器组的IP地址类型。取值如下：ipv4（默认值）：表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6：表示该服务器组仅支持添加IPv6类型的后端服务器。
preserveClientIpEnabled boolean: 是否开启源地址保持。
projectName string: 项目名称。
protocol string: NLB转发流量到后端服务器时使用的通信协议。取值如下：TCP。UDP。
proxyProtocolType string: 是否开启Proxy-Protocol协议。取值如下：off（默认值）：关闭。standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器，还需要在后端服务器上配置Proxy-Protocol。
relatedLoadBalancerIds string[]: 服务器组关联的NLB实例。
scheduler string: NLB转发流量时遵循的规则。取值如下：wrr（默认值）：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。wlc：加权最小连接数，在最少连接数的基础上，根据后端服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。
serverCount number: 服务器组中后端服务器的数量。
serverGroupId string: 服务器组ID。
serverGroupName string: 服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
servers GetNlbServerGroupServer[]: 服务器组中待添加后端服务器的信息。
sessionPersistenceEnabled boolean: 是否开启会话保持。
sessionPersistenceTimeout number: 会话保持的超时时间，取值范围为1～3600秒，默认1000秒。
status string: 服务器组的状态。
tags GetNlbServerGroupTag[]: 标签。
timestampRemoveEnabled boolean: 是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。
type string: 服务器组的类型。取值如下：instance（默认值）：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
updatedTime string: 后端服务器组的更新时间。
vpcId string: 服务器组所属私有网络的ID。

account_id str: 账号ID。
any_port_enabled bool: 是否开启全端口转发。
bypass_security_group_enabled bool: 是否开启放通后端安全组功能。仅参数Type为“instance”时，可以配置此参数。
connection_drain_enabled bool: 是否开启连接优雅中断。
connection_drain_timeout int: 连接优雅中断超时时间，取值范围为0～900秒。参数ConnectionDrainEnabled为“true”时，该参数为必填。
created_time str: 后端服务器组的创建时间。
description str: 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
health_check GetNlbServerGroupHealthCheck: 健康检查相关参数。
id str: Uniquely identifies the resource.
ip_address_version str: 服务器组的IP地址类型。取值如下：ipv4（默认值）：表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6：表示该服务器组仅支持添加IPv6类型的后端服务器。
preserve_client_ip_enabled bool: 是否开启源地址保持。
project_name str: 项目名称。
protocol str: NLB转发流量到后端服务器时使用的通信协议。取值如下：TCP。UDP。
proxy_protocol_type str: 是否开启Proxy-Protocol协议。取值如下：off（默认值）：关闭。standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器，还需要在后端服务器上配置Proxy-Protocol。
related_load_balancer_ids Sequence[str]: 服务器组关联的NLB实例。
scheduler str: NLB转发流量时遵循的规则。取值如下：wrr（默认值）：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。wlc：加权最小连接数，在最少连接数的基础上，根据后端服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。
server_count int: 服务器组中后端服务器的数量。
server_group_id str: 服务器组ID。
server_group_name str: 服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
servers Sequence[GetNlbServerGroupServer]: 服务器组中待添加后端服务器的信息。
session_persistence_enabled bool: 是否开启会话保持。
session_persistence_timeout int: 会话保持的超时时间，取值范围为1～3600秒，默认1000秒。
status str: 服务器组的状态。
tags Sequence[GetNlbServerGroupTag]: 标签。
timestamp_remove_enabled bool: 是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。
type str: 服务器组的类型。取值如下：instance（默认值）：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
updated_time str: 后端服务器组的更新时间。
vpc_id str: 服务器组所属私有网络的ID。

accountId String: 账号ID。
anyPortEnabled Boolean: 是否开启全端口转发。
bypassSecurityGroupEnabled Boolean: 是否开启放通后端安全组功能。仅参数Type为“instance”时，可以配置此参数。
connectionDrainEnabled Boolean: 是否开启连接优雅中断。
connectionDrainTimeout Number: 连接优雅中断超时时间，取值范围为0～900秒。参数ConnectionDrainEnabled为“true”时，该参数为必填。
createdTime String: 后端服务器组的创建时间。
description String: 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
healthCheck Property Map: 健康检查相关参数。
id String: Uniquely identifies the resource.
ipAddressVersion String: 服务器组的IP地址类型。取值如下：ipv4（默认值）：表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6：表示该服务器组仅支持添加IPv6类型的后端服务器。
preserveClientIpEnabled Boolean: 是否开启源地址保持。
projectName String: 项目名称。
protocol String: NLB转发流量到后端服务器时使用的通信协议。取值如下：TCP。UDP。
proxyProtocolType String: 是否开启Proxy-Protocol协议。取值如下：off（默认值）：关闭。standard：开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器，还需要在后端服务器上配置Proxy-Protocol。
relatedLoadBalancerIds List<String>: 服务器组关联的NLB实例。
scheduler String: NLB转发流量时遵循的规则。取值如下：wrr（默认值）：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。wlc：加权最小连接数，在最少连接数的基础上，根据后端服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。
serverCount Number: 服务器组中后端服务器的数量。
serverGroupId String: 服务器组ID。
serverGroupName String: 服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
servers List<Property Map>: 服务器组中待添加后端服务器的信息。
sessionPersistenceEnabled Boolean: 是否开启会话保持。
sessionPersistenceTimeout Number: 会话保持的超时时间，取值范围为1～3600秒，默认1000秒。
status String: 服务器组的状态。
tags List<Property Map>: 标签。
timestampRemoveEnabled Boolean: 是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。
type String: 服务器组的类型。取值如下：instance（默认值）：服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip：IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
updatedTime String: 后端服务器组的更新时间。
vpcId String: 服务器组所属私有网络的ID。

Supporting Types

GetNlbServerGroupHealthCheck

Domain string: 健康检查的域名。
Enabled bool: 是否开启健康检查。
HealthyThreshold int: 健康检查的健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
HttpCode string: 健康检查正常的HTTP状态码。
Interval int: 健康检查的时间间隔，取值范围为1 ～ 300秒，默认值为10秒。
Method string: 健康检查的请求方法。
Port int: 健康检查的端口，取值范围 1～65535。服务器组未开启全端口转发时，该参数默认为0，表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时，必须指定该参数。
Timeout int: 健康检查的响应超时时间，取值范围为1 ～ 60秒，默认值为3秒。如果后端服务器在指定时间内没有正确响应，则判定为健康检查“异常”。
Type string: 健康检查的协议类型。取值如下：取值如下：TCP（默认值）、HTTP、UDP
UdpExpect string: UDP健康检查的请求字符串。只允许包含字母和数字，最大长度限制为64个字符。
UdpRequest string: UDP健康检查的预期响应字符串。
UnhealthyThreshold int: 健康检查的不健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。
Uri string: 健康检查的路径。

Domain string: 健康检查的域名。
Enabled bool: 是否开启健康检查。
HealthyThreshold int: 健康检查的健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
HttpCode string: 健康检查正常的HTTP状态码。
Interval int: 健康检查的时间间隔，取值范围为1 ～ 300秒，默认值为10秒。
Method string: 健康检查的请求方法。
Port int: 健康检查的端口，取值范围 1～65535。服务器组未开启全端口转发时，该参数默认为0，表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时，必须指定该参数。
Timeout int: 健康检查的响应超时时间，取值范围为1 ～ 60秒，默认值为3秒。如果后端服务器在指定时间内没有正确响应，则判定为健康检查“异常”。
Type string: 健康检查的协议类型。取值如下：取值如下：TCP（默认值）、HTTP、UDP
UdpExpect string: UDP健康检查的请求字符串。只允许包含字母和数字，最大长度限制为64个字符。
UdpRequest string: UDP健康检查的预期响应字符串。
UnhealthyThreshold int: 健康检查的不健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。
Uri string: 健康检查的路径。

domain String: 健康检查的域名。
enabled Boolean: 是否开启健康检查。
healthyThreshold Integer: 健康检查的健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
httpCode String: 健康检查正常的HTTP状态码。
interval Integer: 健康检查的时间间隔，取值范围为1 ～ 300秒，默认值为10秒。
method String: 健康检查的请求方法。
port Integer: 健康检查的端口，取值范围 1～65535。服务器组未开启全端口转发时，该参数默认为0，表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时，必须指定该参数。
timeout Integer: 健康检查的响应超时时间，取值范围为1 ～ 60秒，默认值为3秒。如果后端服务器在指定时间内没有正确响应，则判定为健康检查“异常”。
type String: 健康检查的协议类型。取值如下：取值如下：TCP（默认值）、HTTP、UDP
udpExpect String: UDP健康检查的请求字符串。只允许包含字母和数字，最大长度限制为64个字符。
udpRequest String: UDP健康检查的预期响应字符串。
unhealthyThreshold Integer: 健康检查的不健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。
uri String: 健康检查的路径。

domain string: 健康检查的域名。
enabled boolean: 是否开启健康检查。
healthyThreshold number: 健康检查的健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
httpCode string: 健康检查正常的HTTP状态码。
interval number: 健康检查的时间间隔，取值范围为1 ～ 300秒，默认值为10秒。
method string: 健康检查的请求方法。
port number: 健康检查的端口，取值范围 1～65535。服务器组未开启全端口转发时，该参数默认为0，表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时，必须指定该参数。
timeout number: 健康检查的响应超时时间，取值范围为1 ～ 60秒，默认值为3秒。如果后端服务器在指定时间内没有正确响应，则判定为健康检查“异常”。
type string: 健康检查的协议类型。取值如下：取值如下：TCP（默认值）、HTTP、UDP
udpExpect string: UDP健康检查的请求字符串。只允许包含字母和数字，最大长度限制为64个字符。
udpRequest string: UDP健康检查的预期响应字符串。
unhealthyThreshold number: 健康检查的不健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。
uri string: 健康检查的路径。

domain str: 健康检查的域名。
enabled bool: 是否开启健康检查。
healthy_threshold int: 健康检查的健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
http_code str: 健康检查正常的HTTP状态码。
interval int: 健康检查的时间间隔，取值范围为1 ～ 300秒，默认值为10秒。
method str: 健康检查的请求方法。
port int: 健康检查的端口，取值范围 1～65535。服务器组未开启全端口转发时，该参数默认为0，表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时，必须指定该参数。
timeout int: 健康检查的响应超时时间，取值范围为1 ～ 60秒，默认值为3秒。如果后端服务器在指定时间内没有正确响应，则判定为健康检查“异常”。
type str: 健康检查的协议类型。取值如下：取值如下：TCP（默认值）、HTTP、UDP
udp_expect str: UDP健康检查的请求字符串。只允许包含字母和数字，最大长度限制为64个字符。
udp_request str: UDP健康检查的预期响应字符串。
unhealthy_threshold int: 健康检查的不健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。
uri str: 健康检查的路径。

domain String: 健康检查的域名。
enabled Boolean: 是否开启健康检查。
healthyThreshold Number: 健康检查的健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
httpCode String: 健康检查正常的HTTP状态码。
interval Number: 健康检查的时间间隔，取值范围为1 ～ 300秒，默认值为10秒。
method String: 健康检查的请求方法。
port Number: 健康检查的端口，取值范围 1～65535。服务器组未开启全端口转发时，该参数默认为0，表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时，必须指定该参数。
timeout Number: 健康检查的响应超时时间，取值范围为1 ～ 60秒，默认值为3秒。如果后端服务器在指定时间内没有正确响应，则判定为健康检查“异常”。
type String: 健康检查的协议类型。取值如下：取值如下：TCP（默认值）、HTTP、UDP
udpExpect String: UDP健康检查的请求字符串。只允许包含字母和数字，最大长度限制为64个字符。
udpRequest String: UDP健康检查的预期响应字符串。
unhealthyThreshold Number: 健康检查的不健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。
uri String: 健康检查的路径。

GetNlbServerGroupServer

Description string: 后端服务器的描述，默认值为空字符串。
InstanceId string: 服务器实例的ID或IP地址。服务器类型为“ecs”时，传入云服务器实例的ID。您可以调用DescribeInstances接口云服务器实例ID。服务器类型为“eni”时，传入已绑定云服务器实例的网卡ID。您可以调用DescribeNetworkInterfaces接口获取网卡ID。服务器类型为“ip”时，传入后端服务器的IP地址。
Ip string: 后端服务器的私网IP地址。您可以调用DescribeInstances接口获取“ecs”类型后端服务器的私网IP地址。您可以调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
Port int: 后端服务器接收请求的端口号，取值范围为 1～65535。参数AnyPortEnabled为“false”，即服务器组未开启全端口转发时，该参数为必填。参数AnyPortEnabled为“true”，即服务器组开启全端口转发时，该参数默认为0。
ServerId string: 后端服务器 ID。
Type string: 后端服务器的类型。取值如下：ecs：云服务器实例（即主网卡）。eni：辅助网卡。ip：IP地址。
Weight int: 后端服务器的权重，取值范围为0 ～ 100。权重为0，表示不会将请求转发给该服务器。该参数不传入，则默认为0。
ZoneId string: 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时，此参数必填。NLB实例开启跨可用区转发功能时，该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时，则该后端服务器仅接收来自指定可用区的流量。

Description string: 后端服务器的描述，默认值为空字符串。
InstanceId string: 服务器实例的ID或IP地址。服务器类型为“ecs”时，传入云服务器实例的ID。您可以调用DescribeInstances接口云服务器实例ID。服务器类型为“eni”时，传入已绑定云服务器实例的网卡ID。您可以调用DescribeNetworkInterfaces接口获取网卡ID。服务器类型为“ip”时，传入后端服务器的IP地址。
Ip string: 后端服务器的私网IP地址。您可以调用DescribeInstances接口获取“ecs”类型后端服务器的私网IP地址。您可以调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
Port int: 后端服务器接收请求的端口号，取值范围为 1～65535。参数AnyPortEnabled为“false”，即服务器组未开启全端口转发时，该参数为必填。参数AnyPortEnabled为“true”，即服务器组开启全端口转发时，该参数默认为0。
ServerId string: 后端服务器 ID。
Type string: 后端服务器的类型。取值如下：ecs：云服务器实例（即主网卡）。eni：辅助网卡。ip：IP地址。
Weight int: 后端服务器的权重，取值范围为0 ～ 100。权重为0，表示不会将请求转发给该服务器。该参数不传入，则默认为0。
ZoneId string: 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时，此参数必填。NLB实例开启跨可用区转发功能时，该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时，则该后端服务器仅接收来自指定可用区的流量。

description String: 后端服务器的描述，默认值为空字符串。
instanceId String: 服务器实例的ID或IP地址。服务器类型为“ecs”时，传入云服务器实例的ID。您可以调用DescribeInstances接口云服务器实例ID。服务器类型为“eni”时，传入已绑定云服务器实例的网卡ID。您可以调用DescribeNetworkInterfaces接口获取网卡ID。服务器类型为“ip”时，传入后端服务器的IP地址。
ip String: 后端服务器的私网IP地址。您可以调用DescribeInstances接口获取“ecs”类型后端服务器的私网IP地址。您可以调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
port Integer: 后端服务器接收请求的端口号，取值范围为 1～65535。参数AnyPortEnabled为“false”，即服务器组未开启全端口转发时，该参数为必填。参数AnyPortEnabled为“true”，即服务器组开启全端口转发时，该参数默认为0。
serverId String: 后端服务器 ID。
type String: 后端服务器的类型。取值如下：ecs：云服务器实例（即主网卡）。eni：辅助网卡。ip：IP地址。
weight Integer: 后端服务器的权重，取值范围为0 ～ 100。权重为0，表示不会将请求转发给该服务器。该参数不传入，则默认为0。
zoneId String: 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时，此参数必填。NLB实例开启跨可用区转发功能时，该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时，则该后端服务器仅接收来自指定可用区的流量。

description string: 后端服务器的描述，默认值为空字符串。
instanceId string: 服务器实例的ID或IP地址。服务器类型为“ecs”时，传入云服务器实例的ID。您可以调用DescribeInstances接口云服务器实例ID。服务器类型为“eni”时，传入已绑定云服务器实例的网卡ID。您可以调用DescribeNetworkInterfaces接口获取网卡ID。服务器类型为“ip”时，传入后端服务器的IP地址。
ip string: 后端服务器的私网IP地址。您可以调用DescribeInstances接口获取“ecs”类型后端服务器的私网IP地址。您可以调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
port number: 后端服务器接收请求的端口号，取值范围为 1～65535。参数AnyPortEnabled为“false”，即服务器组未开启全端口转发时，该参数为必填。参数AnyPortEnabled为“true”，即服务器组开启全端口转发时，该参数默认为0。
serverId string: 后端服务器 ID。
type string: 后端服务器的类型。取值如下：ecs：云服务器实例（即主网卡）。eni：辅助网卡。ip：IP地址。
weight number: 后端服务器的权重，取值范围为0 ～ 100。权重为0，表示不会将请求转发给该服务器。该参数不传入，则默认为0。
zoneId string: 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时，此参数必填。NLB实例开启跨可用区转发功能时，该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时，则该后端服务器仅接收来自指定可用区的流量。

description str: 后端服务器的描述，默认值为空字符串。
instance_id str: 服务器实例的ID或IP地址。服务器类型为“ecs”时，传入云服务器实例的ID。您可以调用DescribeInstances接口云服务器实例ID。服务器类型为“eni”时，传入已绑定云服务器实例的网卡ID。您可以调用DescribeNetworkInterfaces接口获取网卡ID。服务器类型为“ip”时，传入后端服务器的IP地址。
ip str: 后端服务器的私网IP地址。您可以调用DescribeInstances接口获取“ecs”类型后端服务器的私网IP地址。您可以调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
port int: 后端服务器接收请求的端口号，取值范围为 1～65535。参数AnyPortEnabled为“false”，即服务器组未开启全端口转发时，该参数为必填。参数AnyPortEnabled为“true”，即服务器组开启全端口转发时，该参数默认为0。
server_id str: 后端服务器 ID。
type str: 后端服务器的类型。取值如下：ecs：云服务器实例（即主网卡）。eni：辅助网卡。ip：IP地址。
weight int: 后端服务器的权重，取值范围为0 ～ 100。权重为0，表示不会将请求转发给该服务器。该参数不传入，则默认为0。
zone_id str: 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时，此参数必填。NLB实例开启跨可用区转发功能时，该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时，则该后端服务器仅接收来自指定可用区的流量。

description String: 后端服务器的描述，默认值为空字符串。
instanceId String: 服务器实例的ID或IP地址。服务器类型为“ecs”时，传入云服务器实例的ID。您可以调用DescribeInstances接口云服务器实例ID。服务器类型为“eni”时，传入已绑定云服务器实例的网卡ID。您可以调用DescribeNetworkInterfaces接口获取网卡ID。服务器类型为“ip”时，传入后端服务器的IP地址。
ip String: 后端服务器的私网IP地址。您可以调用DescribeInstances接口获取“ecs”类型后端服务器的私网IP地址。您可以调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
port Number: 后端服务器接收请求的端口号，取值范围为 1～65535。参数AnyPortEnabled为“false”，即服务器组未开启全端口转发时，该参数为必填。参数AnyPortEnabled为“true”，即服务器组开启全端口转发时，该参数默认为0。
serverId String: 后端服务器 ID。
type String: 后端服务器的类型。取值如下：ecs：云服务器实例（即主网卡）。eni：辅助网卡。ip：IP地址。
weight Number: 后端服务器的权重，取值范围为0 ～ 100。权重为0，表示不会将请求转发给该服务器。该参数不传入，则默认为0。
zoneId String: 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时，此参数必填。NLB实例开启跨可用区转发功能时，该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时，则该后端服务器仅接收来自指定可用区的流量。

GetNlbServerGroupTag

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: 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.getNlbServerGroup

On this page

On this page

Using getNlbServerGroup

getNlbServerGroup Result

Supporting Types

GetNlbServerGroupHealthCheck

GetNlbServerGroupServer

GetNlbServerGroupTag

Package Details

On this page

On this page