volcenginecc.clb.getNlbServerGroup

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

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: volcenginecc: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: Account ID
AnyPortEnabled bool: Enable all-port forwarding
BypassSecurityGroupEnabled bool: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
ConnectionDrainEnabled bool: Enable graceful connection termination.
ConnectionDrainTimeout int: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
CreatedTime string: Backend server group creation time
Description string: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
HealthCheck Volcengine.GetNlbServerGroupHealthCheck: Health check parameters
Id string: Uniquely identifies the resource.
IpAddressVersion string: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
PreserveClientIpEnabled bool: Enable source address persistence
ProjectName string: Project name
Protocol string: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
ProxyProtocolType string: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
RelatedLoadBalancerIds List<string>: NLB instance associated with the server group.
Scheduler string: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: Server group ID
ServerGroupName string: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
Servers List<Volcengine.GetNlbServerGroupServer>: Information about backend servers to be added to the server group
SessionPersistenceEnabled bool: Enable session persistence.
SessionPersistenceTimeout int: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
Status string: Server group status
Tags List<Volcengine.GetNlbServerGroupTag>: Tag
TimestampRemoveEnabled bool: Enable removal of TCP/HTTP/HTTPS packet timestamps
Type string: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
UpdatedTime string: Last update time of the backend server group.
VpcId string: ID of the private network to which the server group belongs

AccountId string: Account ID
AnyPortEnabled bool: Enable all-port forwarding
BypassSecurityGroupEnabled bool: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
ConnectionDrainEnabled bool: Enable graceful connection termination.
ConnectionDrainTimeout int: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
CreatedTime string: Backend server group creation time
Description string: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
HealthCheck GetNlbServerGroupHealthCheck: Health check parameters
Id string: Uniquely identifies the resource.
IpAddressVersion string: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
PreserveClientIpEnabled bool: Enable source address persistence
ProjectName string: Project name
Protocol string: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
ProxyProtocolType string: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
RelatedLoadBalancerIds []string: NLB instance associated with the server group.
Scheduler string: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
ServerCount int: Number of backend servers in the server group.
ServerGroupId string: Server group ID
ServerGroupName string: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
Servers []GetNlbServerGroupServer: Information about backend servers to be added to the server group
SessionPersistenceEnabled bool: Enable session persistence.
SessionPersistenceTimeout int: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
Status string: Server group status
Tags []GetNlbServerGroupTag: Tag
TimestampRemoveEnabled bool: Enable removal of TCP/HTTP/HTTPS packet timestamps
Type string: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
UpdatedTime string: Last update time of the backend server group.
VpcId string: ID of the private network to which the server group belongs

accountId String: Account ID
anyPortEnabled Boolean: Enable all-port forwarding
bypassSecurityGroupEnabled Boolean: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connectionDrainEnabled Boolean: Enable graceful connection termination.
connectionDrainTimeout Integer: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
createdTime String: Backend server group creation time
description String: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
healthCheck GetNlbServerGroupHealthCheck: Health check parameters
id String: Uniquely identifies the resource.
ipAddressVersion String: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserveClientIpEnabled Boolean: Enable source address persistence
projectName String: Project name
protocol String: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
proxyProtocolType String: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
relatedLoadBalancerIds List<String>: NLB instance associated with the server group.
scheduler String: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
serverCount Integer: Number of backend servers in the server group.
serverGroupId String: Server group ID
serverGroupName String: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers List<GetNlbServerGroupServer>: Information about backend servers to be added to the server group
sessionPersistenceEnabled Boolean: Enable session persistence.
sessionPersistenceTimeout Integer: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
status String: Server group status
tags List<GetNlbServerGroupTag>: Tag
timestampRemoveEnabled Boolean: Enable removal of TCP/HTTP/HTTPS packet timestamps
type String: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
updatedTime String: Last update time of the backend server group.
vpcId String: ID of the private network to which the server group belongs

accountId string: Account ID
anyPortEnabled boolean: Enable all-port forwarding
bypassSecurityGroupEnabled boolean: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connectionDrainEnabled boolean: Enable graceful connection termination.
connectionDrainTimeout number: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
createdTime string: Backend server group creation time
description string: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
healthCheck GetNlbServerGroupHealthCheck: Health check parameters
id string: Uniquely identifies the resource.
ipAddressVersion string: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserveClientIpEnabled boolean: Enable source address persistence
projectName string: Project name
protocol string: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
proxyProtocolType string: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
relatedLoadBalancerIds string[]: NLB instance associated with the server group.
scheduler string: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
serverCount number: Number of backend servers in the server group.
serverGroupId string: Server group ID
serverGroupName string: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers GetNlbServerGroupServer[]: Information about backend servers to be added to the server group
sessionPersistenceEnabled boolean: Enable session persistence.
sessionPersistenceTimeout number: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
status string: Server group status
tags GetNlbServerGroupTag[]: Tag
timestampRemoveEnabled boolean: Enable removal of TCP/HTTP/HTTPS packet timestamps
type string: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
updatedTime string: Last update time of the backend server group.
vpcId string: ID of the private network to which the server group belongs

account_id str: Account ID
any_port_enabled bool: Enable all-port forwarding
bypass_security_group_enabled bool: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connection_drain_enabled bool: Enable graceful connection termination.
connection_drain_timeout int: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
created_time str: Backend server group creation time
description str: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
health_check GetNlbServerGroupHealthCheck: Health check parameters
id str: Uniquely identifies the resource.
ip_address_version str: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserve_client_ip_enabled bool: Enable source address persistence
project_name str: Project name
protocol str: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
proxy_protocol_type str: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
related_load_balancer_ids Sequence[str]: NLB instance associated with the server group.
scheduler str: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
server_count int: Number of backend servers in the server group.
server_group_id str: Server group ID
server_group_name str: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers Sequence[GetNlbServerGroupServer]: Information about backend servers to be added to the server group
session_persistence_enabled bool: Enable session persistence.
session_persistence_timeout int: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
status str: Server group status
tags Sequence[GetNlbServerGroupTag]: Tag
timestamp_remove_enabled bool: Enable removal of TCP/HTTP/HTTPS packet timestamps
type str: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
updated_time str: Last update time of the backend server group.
vpc_id str: ID of the private network to which the server group belongs

accountId String: Account ID
anyPortEnabled Boolean: Enable all-port forwarding
bypassSecurityGroupEnabled Boolean: Enable backend security group pass-through. This parameter can only be configured when Type is 'instance'.
connectionDrainEnabled Boolean: Enable graceful connection termination.
connectionDrainTimeout Number: Connection graceful shutdown timeout, range: 0–900 seconds. If ConnectionDrainEnabled is 'true', this parameter is required.
createdTime String: Backend server group creation time
description String: Description of the backend server group, description of the server group. Must start with a letter, number, or Chinese character, and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period（。）. Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
healthCheck Property Map: Health check parameters
id String: Uniquely identifies the resource.
ipAddressVersion String: IP address type of the server group. Options: ipv4 (default): The server group only supports adding IPv4 type backend servers. ipv6: The server group only supports adding IPv6 type backend servers.
preserveClientIpEnabled Boolean: Enable source address persistence
projectName String: Project name
protocol String: Communication protocol used by NLB to forward traffic to backend servers. Options: TCP. UDP.
proxyProtocolType String: Enable Proxy-Protocol. Available values: off (default): disabled. standard: enabled. NLB forwards the client source IP address to the backend server via Proxy-Protocol. Proxy-Protocol must also be configured on the backend server.
relatedLoadBalancerIds List<String>: NLB instance associated with the server group.
scheduler String: Rules followed by NLB when forwarding traffic. Options: wrr (default): Weighted round robin. Backend servers with higher weights are selected more frequently (higher probability). wlc: Weighted least connections. Based on the least number of connections, assigns different weights to backend servers according to their processing capabilities, allowing each server to handle a corresponding number of service requests. sh: Source address hash. Uses consistent hashing based on the source IP address; requests from the same source address are routed to the same backend server.
serverCount Number: Number of backend servers in the server group.
serverGroupId String: Server group ID
serverGroupName String: Server group name. Must start with a letter, number, or Chinese character, and can include the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the server group ID
servers List<Property Map>: Information about backend servers to be added to the server group
sessionPersistenceEnabled Boolean: Enable session persistence.
sessionPersistenceTimeout Number: Session persistence timeout. Range: 1–3600 seconds, default: 1000 seconds
status String: Server group status
tags List<Property Map>: Tag
timestampRemoveEnabled Boolean: Enable removal of TCP/HTTP/HTTPS packet timestamps
type String: Server group type. Available values: instance (default): server type. Supports adding cloud server instances and auxiliary network interfaces bound to cloud server instances as backend servers. ip: IP address type. Supports adding any network-accessible server in a VPC or IDC as a backend server.
updatedTime String: Last update time of the backend server group.
vpcId String: ID of the private network to which the server group belongs

Supporting Types

GetNlbServerGroupHealthCheck

Domain string: Health check domain name
Enabled bool: Enable health check
HealthyThreshold int: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
HttpCode string: HTTP status codes indicating a healthy health check.
Interval int: Health check interval, range: 1–300 seconds, default: 10 seconds.
Method string: Health check request method
Port int: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
Timeout int: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
Type string: Health check protocol type. Options: TCP (default), HTTP, UDP
UdpExpect string: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
UdpRequest string: Expected response string for UDP health check
UnhealthyThreshold int: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
Uri string: Health check path

Domain string: Health check domain name
Enabled bool: Enable health check
HealthyThreshold int: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
HttpCode string: HTTP status codes indicating a healthy health check.
Interval int: Health check interval, range: 1–300 seconds, default: 10 seconds.
Method string: Health check request method
Port int: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
Timeout int: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
Type string: Health check protocol type. Options: TCP (default), HTTP, UDP
UdpExpect string: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
UdpRequest string: Expected response string for UDP health check
UnhealthyThreshold int: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
Uri string: Health check path

domain String: Health check domain name
enabled Boolean: Enable health check
healthyThreshold Integer: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
httpCode String: HTTP status codes indicating a healthy health check.
interval Integer: Health check interval, range: 1–300 seconds, default: 10 seconds.
method String: Health check request method
port Integer: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
timeout Integer: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
type String: Health check protocol type. Options: TCP (default), HTTP, UDP
udpExpect String: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
udpRequest String: Expected response string for UDP health check
unhealthyThreshold Integer: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
uri String: Health check path

domain string: Health check domain name
enabled boolean: Enable health check
healthyThreshold number: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
httpCode string: HTTP status codes indicating a healthy health check.
interval number: Health check interval, range: 1–300 seconds, default: 10 seconds.
method string: Health check request method
port number: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
timeout number: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
type string: Health check protocol type. Options: TCP (default), HTTP, UDP
udpExpect string: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
udpRequest string: Expected response string for UDP health check
unhealthyThreshold number: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
uri string: Health check path

domain str: Health check domain name
enabled bool: Enable health check
healthy_threshold int: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
http_code str: HTTP status codes indicating a healthy health check.
interval int: Health check interval, range: 1–300 seconds, default: 10 seconds.
method str: Health check request method
port int: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
timeout int: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
type str: Health check protocol type. Options: TCP (default), HTTP, UDP
udp_expect str: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
udp_request str: Expected response string for UDP health check
unhealthy_threshold int: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
uri str: Health check path

domain String: Health check domain name
enabled Boolean: Enable health check
healthyThreshold Number: Health check healthy threshold. Range: 2–10 times, default: 3 times. If the backend server passes the specified number of consecutive health checks with 'normal' results, it is considered health check 'normal'
httpCode String: HTTP status codes indicating a healthy health check.
interval Number: Health check interval, range: 1–300 seconds, default: 10 seconds.
method String: Health check request method
port Number: Health check port. Range: 1–65535. If full port forwarding is not enabled for the server group, this parameter defaults to 0, meaning the backend server's port is used for health checks. If full port forwarding is enabled, this parameter must be specified
timeout Number: Health check response timeout. Range: 1–60 seconds, default: 3 seconds. If the backend server does not respond correctly within the specified time, it is considered health check 'abnormal'
type String: Health check protocol type. Options: TCP (default), HTTP, UDP
udpExpect String: UDP health check request string. Only letters and numbers are allowed, with a maximum length of 64 characters.
udpRequest String: Expected response string for UDP health check
unhealthyThreshold Number: Health check unhealthy threshold. Range: 2–10 times, default: 3 times. If the backend server fails the specified number of consecutive health checks with 'abnormal' results, it is considered health check abnormal
uri String: Health check path

GetNlbServerGroupServer

Description string: Description of the backend server, default is an empty string.
InstanceId string: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
Ip string: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
Port int: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
ServerId string: Backend server ID
Type string: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
Weight int: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
ZoneId string: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

Description string: Description of the backend server, default is an empty string.
InstanceId string: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
Ip string: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
Port int: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
ServerId string: Backend server ID
Type string: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
Weight int: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
ZoneId string: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

description String: Description of the backend server, default is an empty string.
instanceId String: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
ip String: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
port Integer: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
serverId String: Backend server ID
type String: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
weight Integer: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
zoneId String: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

description string: Description of the backend server, default is an empty string.
instanceId string: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
ip string: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
port number: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
serverId string: Backend server ID
type string: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
weight number: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
zoneId string: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

description str: Description of the backend server, default is an empty string.
instance_id str: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
ip str: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
port int: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
server_id str: Backend server ID
type str: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
weight int: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
zone_id str: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

description String: Description of the backend server, default is an empty string.
instanceId String: Server instance ID or IP address. If the server type is 'ecs', enter the cloud server instance ID. You can call the DescribeInstances API to obtain the cloud server instance ID. If the server type is 'eni', enter the network interface card ID bound to the cloud server instance. You can call the DescribeNetworkInterfaces API to obtain the network interface card ID. If the server type is 'ip', enter the backend server's IP address.
ip String: Private IP address of the backend server. You can call the DescribeInstances API to obtain the private IP address of an 'ecs' type backend server. You can call the DescribeNetworkInterfaces API to obtain the private IP address of an 'eni' type backend server.
port Number: Port number on which the backend server receives requests, range: 1–65535. If AnyPortEnabled is 'false' (all-port forwarding is disabled), this parameter is required. If AnyPortEnabled is 'true' (all-port forwarding is enabled), the default value is 0.
serverId String: Backend server ID
type String: Backend server type. Available values: ecs: cloud server instance (primary network interface). eni: auxiliary network interface. ip: IP address.
weight Number: Backend server weight, range: 0–100. Weight of 0 means requests will not be forwarded to this server. If not specified, the default is 0.
zoneId String: Specify the availability zone of the NLB instance associated with the backend server. This parameter is required when Servers.N.Type is ip. If the NLB instance enables cross-zone forwarding, the backend server can receive traffic from all availability zones of the NLB instance. If cross-zone forwarding is disabled, the backend server only receives traffic from the specified availability zone

GetNlbServerGroupTag

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.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.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