1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. clb
  5. NlbServerGroup
volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine
volcengine/pulumi-volcenginecc

volcenginecc.clb.NlbServerGroup

Deploy with Pulumi
volcenginecc logo
volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine
volcengine/pulumi-volcenginecc

    服务器组

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  nLBServerGroupDemo:
    type: volcenginecc:clb:NlbServerGroup
    name: NLBServerGroupDemo
    properties:
      bypassSecurityGroupEnabled: false
      healthCheck:
        enabled: false
      vpcId: vpc-13f8k4dwdsydc3n6nu5rxxxxx
      projectName: default
      serverGroupName: NLBServerGroupDemo.Aa1xxxxx
      type: instance
      protocol: UDP
      description: test.IPV4.UDP.WLC_=
      scheduler: wlc
      ipAddressVersion: ipv4
      anyPortEnabled: false
      connectionDrainEnabled: false
      preserveClientIpEnabled: false
      sessionPersistenceEnabled: false
      proxyProtocolType: off
      servers:
        - instance_id: i-ye2fvd0qo0bw80ctxxxxx
          type: ecs
          ip: 192.168.xx.76
          port: 10
          weight: 50
        - instance_id: eni-mirt64nt1xq85smt1a3xxxxx
          type: eni
          ip: 192.168.xx.77
          port: 20
          weight: 50
      tags:
        - key: env
          value: test

    Create NlbServerGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NlbServerGroup(name: string, args: NlbServerGroupArgs, opts?: CustomResourceOptions);
    @overload
def NlbServerGroup(resource_name: str,
                   args: NlbServerGroupArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def NlbServerGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   protocol: Optional[str] = None,
                   vpc_id: Optional[str] = None,
                   project_name: Optional[str] = None,
                   scheduler: Optional[str] = None,
                   connection_drain_timeout: Optional[int] = None,
                   created_time: Optional[str] = None,
                   description: Optional[str] = None,
                   health_check: Optional[NlbServerGroupHealthCheckArgs] = None,
                   ip_address_version: Optional[str] = None,
                   preserve_client_ip_enabled: Optional[bool] = None,
                   account_id: Optional[str] = None,
                   bypass_security_group_enabled: Optional[bool] = None,
                   proxy_protocol_type: Optional[str] = None,
                   connection_drain_enabled: Optional[bool] = None,
                   server_group_name: Optional[str] = None,
                   servers: Optional[Sequence[NlbServerGroupServerArgs]] = None,
                   session_persistence_enabled: Optional[bool] = None,
                   session_persistence_timeout: Optional[int] = None,
                   tags: Optional[Sequence[NlbServerGroupTagArgs]] = None,
                   timestamp_remove_enabled: Optional[bool] = None,
                   type: Optional[str] = None,
                   updated_time: Optional[str] = None,
                   any_port_enabled: Optional[bool] = None)
    func NewNlbServerGroup(ctx *Context, name string, args NlbServerGroupArgs, opts ...ResourceOption) (*NlbServerGroup, error)
    public NlbServerGroup(string name, NlbServerGroupArgs args, CustomResourceOptions? opts = null)
    public NlbServerGroup(String name, NlbServerGroupArgs args)
public NlbServerGroup(String name, NlbServerGroupArgs args, CustomResourceOptions options)

    type: volcenginecc:clb:NlbServerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args NlbServerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NlbServerGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NlbServerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NlbServerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NlbServerGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var nlbServerGroupResource = new Volcenginecc.Clb.NlbServerGroup("nlbServerGroupResource", new()
{
    Protocol = "string",
    VpcId = "string",
    ProjectName = "string",
    Scheduler = "string",
    ConnectionDrainTimeout = 0,
    CreatedTime = "string",
    Description = "string",
    HealthCheck = new Volcenginecc.Clb.Inputs.NlbServerGroupHealthCheckArgs
    {
        Domain = "string",
        Enabled = false,
        HealthyThreshold = 0,
        HttpCode = "string",
        Interval = 0,
        Method = "string",
        Port = 0,
        Timeout = 0,
        Type = "string",
        UdpExpect = "string",
        UdpRequest = "string",
        UnhealthyThreshold = 0,
        Uri = "string",
    },
    IpAddressVersion = "string",
    PreserveClientIpEnabled = false,
    AccountId = "string",
    BypassSecurityGroupEnabled = false,
    ProxyProtocolType = "string",
    ConnectionDrainEnabled = false,
    ServerGroupName = "string",
    Servers = new[]
    {
        new Volcenginecc.Clb.Inputs.NlbServerGroupServerArgs
        {
            Description = "string",
            InstanceId = "string",
            Ip = "string",
            Port = 0,
            ServerId = "string",
            Type = "string",
            Weight = 0,
            ZoneId = "string",
        },
    },
    SessionPersistenceEnabled = false,
    SessionPersistenceTimeout = 0,
    Tags = new[]
    {
        new Volcenginecc.Clb.Inputs.NlbServerGroupTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TimestampRemoveEnabled = false,
    Type = "string",
    UpdatedTime = "string",
    AnyPortEnabled = false,
});

    example, err := clb.NewNlbServerGroup(ctx, "nlbServerGroupResource", &clb.NlbServerGroupArgs{
	Protocol:               pulumi.String("string"),
	VpcId:                  pulumi.String("string"),
	ProjectName:            pulumi.String("string"),
	Scheduler:              pulumi.String("string"),
	ConnectionDrainTimeout: pulumi.Int(0),
	CreatedTime:            pulumi.String("string"),
	Description:            pulumi.String("string"),
	HealthCheck: &clb.NlbServerGroupHealthCheckArgs{
		Domain:             pulumi.String("string"),
		Enabled:            pulumi.Bool(false),
		HealthyThreshold:   pulumi.Int(0),
		HttpCode:           pulumi.String("string"),
		Interval:           pulumi.Int(0),
		Method:             pulumi.String("string"),
		Port:               pulumi.Int(0),
		Timeout:            pulumi.Int(0),
		Type:               pulumi.String("string"),
		UdpExpect:          pulumi.String("string"),
		UdpRequest:         pulumi.String("string"),
		UnhealthyThreshold: pulumi.Int(0),
		Uri:                pulumi.String("string"),
	},
	IpAddressVersion:           pulumi.String("string"),
	PreserveClientIpEnabled:    pulumi.Bool(false),
	AccountId:                  pulumi.String("string"),
	BypassSecurityGroupEnabled: pulumi.Bool(false),
	ProxyProtocolType:          pulumi.String("string"),
	ConnectionDrainEnabled:     pulumi.Bool(false),
	ServerGroupName:            pulumi.String("string"),
	Servers: clb.NlbServerGroupServerArray{
		&clb.NlbServerGroupServerArgs{
			Description: pulumi.String("string"),
			InstanceId:  pulumi.String("string"),
			Ip:          pulumi.String("string"),
			Port:        pulumi.Int(0),
			ServerId:    pulumi.String("string"),
			Type:        pulumi.String("string"),
			Weight:      pulumi.Int(0),
			ZoneId:      pulumi.String("string"),
		},
	},
	SessionPersistenceEnabled: pulumi.Bool(false),
	SessionPersistenceTimeout: pulumi.Int(0),
	Tags: clb.NlbServerGroupTagArray{
		&clb.NlbServerGroupTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TimestampRemoveEnabled: pulumi.Bool(false),
	Type:                   pulumi.String("string"),
	UpdatedTime:            pulumi.String("string"),
	AnyPortEnabled:         pulumi.Bool(false),
})

    var nlbServerGroupResource = new NlbServerGroup("nlbServerGroupResource", NlbServerGroupArgs.builder()
    .protocol("string")
    .vpcId("string")
    .projectName("string")
    .scheduler("string")
    .connectionDrainTimeout(0)
    .createdTime("string")
    .description("string")
    .healthCheck(NlbServerGroupHealthCheckArgs.builder()
        .domain("string")
        .enabled(false)
        .healthyThreshold(0)
        .httpCode("string")
        .interval(0)
        .method("string")
        .port(0)
        .timeout(0)
        .type("string")
        .udpExpect("string")
        .udpRequest("string")
        .unhealthyThreshold(0)
        .uri("string")
        .build())
    .ipAddressVersion("string")
    .preserveClientIpEnabled(false)
    .accountId("string")
    .bypassSecurityGroupEnabled(false)
    .proxyProtocolType("string")
    .connectionDrainEnabled(false)
    .serverGroupName("string")
    .servers(NlbServerGroupServerArgs.builder()
        .description("string")
        .instanceId("string")
        .ip("string")
        .port(0)
        .serverId("string")
        .type("string")
        .weight(0)
        .zoneId("string")
        .build())
    .sessionPersistenceEnabled(false)
    .sessionPersistenceTimeout(0)
    .tags(NlbServerGroupTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .timestampRemoveEnabled(false)
    .type("string")
    .updatedTime("string")
    .anyPortEnabled(false)
    .build());

    nlb_server_group_resource = volcenginecc.clb.NlbServerGroup("nlbServerGroupResource",
    protocol="string",
    vpc_id="string",
    project_name="string",
    scheduler="string",
    connection_drain_timeout=0,
    created_time="string",
    description="string",
    health_check={
        "domain": "string",
        "enabled": False,
        "healthy_threshold": 0,
        "http_code": "string",
        "interval": 0,
        "method": "string",
        "port": 0,
        "timeout": 0,
        "type": "string",
        "udp_expect": "string",
        "udp_request": "string",
        "unhealthy_threshold": 0,
        "uri": "string",
    },
    ip_address_version="string",
    preserve_client_ip_enabled=False,
    account_id="string",
    bypass_security_group_enabled=False,
    proxy_protocol_type="string",
    connection_drain_enabled=False,
    server_group_name="string",
    servers=[{
        "description": "string",
        "instance_id": "string",
        "ip": "string",
        "port": 0,
        "server_id": "string",
        "type": "string",
        "weight": 0,
        "zone_id": "string",
    }],
    session_persistence_enabled=False,
    session_persistence_timeout=0,
    tags=[{
        "key": "string",
        "value": "string",
    }],
    timestamp_remove_enabled=False,
    type="string",
    updated_time="string",
    any_port_enabled=False)

    const nlbServerGroupResource = new volcenginecc.clb.NlbServerGroup("nlbServerGroupResource", {
    protocol: "string",
    vpcId: "string",
    projectName: "string",
    scheduler: "string",
    connectionDrainTimeout: 0,
    createdTime: "string",
    description: "string",
    healthCheck: {
        domain: "string",
        enabled: false,
        healthyThreshold: 0,
        httpCode: "string",
        interval: 0,
        method: "string",
        port: 0,
        timeout: 0,
        type: "string",
        udpExpect: "string",
        udpRequest: "string",
        unhealthyThreshold: 0,
        uri: "string",
    },
    ipAddressVersion: "string",
    preserveClientIpEnabled: false,
    accountId: "string",
    bypassSecurityGroupEnabled: false,
    proxyProtocolType: "string",
    connectionDrainEnabled: false,
    serverGroupName: "string",
    servers: [{
        description: "string",
        instanceId: "string",
        ip: "string",
        port: 0,
        serverId: "string",
        type: "string",
        weight: 0,
        zoneId: "string",
    }],
    sessionPersistenceEnabled: false,
    sessionPersistenceTimeout: 0,
    tags: [{
        key: "string",
        value: "string",
    }],
    timestampRemoveEnabled: false,
    type: "string",
    updatedTime: "string",
    anyPortEnabled: false,
});

    type: volcenginecc:clb:NlbServerGroup
properties:
    accountId: string
    anyPortEnabled: false
    bypassSecurityGroupEnabled: false
    connectionDrainEnabled: false
    connectionDrainTimeout: 0
    createdTime: string
    description: string
    healthCheck:
        domain: string
        enabled: false
        healthyThreshold: 0
        httpCode: string
        interval: 0
        method: string
        port: 0
        timeout: 0
        type: string
        udpExpect: string
        udpRequest: string
        unhealthyThreshold: 0
        uri: string
    ipAddressVersion: string
    preserveClientIpEnabled: false
    projectName: string
    protocol: string
    proxyProtocolType: string
    scheduler: string
    serverGroupName: string
    servers:
        - description: string
          instanceId: string
          ip: string
          port: 0
          serverId: string
          type: string
          weight: 0
          zoneId: string
    sessionPersistenceEnabled: false
    sessionPersistenceTimeout: 0
    tags:
        - key: string
          value: string
    timestampRemoveEnabled: false
    type: string
    updatedTime: string
    vpcId: string

    NlbServerGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NlbServerGroup resource accepts the following input properties:

    Protocol string
    NLB转发流量到后端服务器时使用的通信协议
    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 Volcengine.NlbServerGroupHealthCheck
    健康检查相关参数
    IpAddressVersion string
    服务器组的IP地址类型
    PreserveClientIpEnabled bool
    是否开启源地址保持
    ProjectName string
    项目名称
    ProxyProtocolType string
    是否开启Proxy-Protocol协议
    Scheduler string
    NLB转发流量时遵循的规则
    ServerGroupName string
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    Servers List<Volcengine.NlbServerGroupServer>
    SessionPersistenceEnabled bool
    是否开启会话保持
    SessionPersistenceTimeout int
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    Tags List<Volcengine.NlbServerGroupTag>
    TimestampRemoveEnabled bool
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    Type string
    服务器组的类型
    UpdatedTime string
    后端服务器组的更新时间
    Protocol string
    NLB转发流量到后端服务器时使用的通信协议
    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 NlbServerGroupHealthCheckArgs
    健康检查相关参数
    IpAddressVersion string
    服务器组的IP地址类型
    PreserveClientIpEnabled bool
    是否开启源地址保持
    ProjectName string
    项目名称
    ProxyProtocolType string
    是否开启Proxy-Protocol协议
    Scheduler string
    NLB转发流量时遵循的规则
    ServerGroupName string
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    Servers []NlbServerGroupServerArgs
    SessionPersistenceEnabled bool
    是否开启会话保持
    SessionPersistenceTimeout int
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    Tags []NlbServerGroupTagArgs
    TimestampRemoveEnabled bool
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    Type string
    服务器组的类型
    UpdatedTime string
    后端服务器组的更新时间
    protocol String
    NLB转发流量到后端服务器时使用的通信协议
    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 NlbServerGroupHealthCheck
    健康检查相关参数
    ipAddressVersion String
    服务器组的IP地址类型
    preserveClientIpEnabled Boolean
    是否开启源地址保持
    projectName String
    项目名称
    proxyProtocolType String
    是否开启Proxy-Protocol协议
    scheduler String
    NLB转发流量时遵循的规则
    serverGroupName String
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    servers List<NlbServerGroupServer>
    sessionPersistenceEnabled Boolean
    是否开启会话保持
    sessionPersistenceTimeout Integer
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    tags List<NlbServerGroupTag>
    timestampRemoveEnabled Boolean
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    type String
    服务器组的类型
    updatedTime String
    后端服务器组的更新时间
    protocol string
    NLB转发流量到后端服务器时使用的通信协议
    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 NlbServerGroupHealthCheck
    健康检查相关参数
    ipAddressVersion string
    服务器组的IP地址类型
    preserveClientIpEnabled boolean
    是否开启源地址保持
    projectName string
    项目名称
    proxyProtocolType string
    是否开启Proxy-Protocol协议
    scheduler string
    NLB转发流量时遵循的规则
    serverGroupName string
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    servers NlbServerGroupServer[]
    sessionPersistenceEnabled boolean
    是否开启会话保持
    sessionPersistenceTimeout number
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    tags NlbServerGroupTag[]
    timestampRemoveEnabled boolean
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    type string
    服务器组的类型
    updatedTime string
    后端服务器组的更新时间
    protocol str
    NLB转发流量到后端服务器时使用的通信协议
    vpc_id str
    服务器组所属私有网络的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 NlbServerGroupHealthCheckArgs
    健康检查相关参数
    ip_address_version str
    服务器组的IP地址类型
    preserve_client_ip_enabled bool
    是否开启源地址保持
    project_name str
    项目名称
    proxy_protocol_type str
    是否开启Proxy-Protocol协议
    scheduler str
    NLB转发流量时遵循的规则
    server_group_name str
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    servers Sequence[NlbServerGroupServerArgs]
    session_persistence_enabled bool
    是否开启会话保持
    session_persistence_timeout int
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    tags Sequence[NlbServerGroupTagArgs]
    timestamp_remove_enabled bool
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    type str
    服务器组的类型
    updated_time str
    后端服务器组的更新时间
    protocol String
    NLB转发流量到后端服务器时使用的通信协议
    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 Property Map
    健康检查相关参数
    ipAddressVersion String
    服务器组的IP地址类型
    preserveClientIpEnabled Boolean
    是否开启源地址保持
    projectName String
    项目名称
    proxyProtocolType String
    是否开启Proxy-Protocol协议
    scheduler String
    NLB转发流量时遵循的规则
    serverGroupName String
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    servers List<Property Map>
    sessionPersistenceEnabled Boolean
    是否开启会话保持
    sessionPersistenceTimeout Number
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    tags List<Property Map>
    timestampRemoveEnabled Boolean
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    type String
    服务器组的类型
    updatedTime String
    后端服务器组的更新时间

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NlbServerGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RelatedLoadBalancerIds List<string>
    服务器组关联的NLB实例
    ServerCount int
    服务器组中后端服务器的数量
    ServerGroupId string
    服务器组ID
    Status string
    服务器组的状态
    Id string
    The provider-assigned unique ID for this managed resource.
    RelatedLoadBalancerIds []string
    服务器组关联的NLB实例
    ServerCount int
    服务器组中后端服务器的数量
    ServerGroupId string
    服务器组ID
    Status string
    服务器组的状态
    id String
    The provider-assigned unique ID for this managed resource.
    relatedLoadBalancerIds List<String>
    服务器组关联的NLB实例
    serverCount Integer
    服务器组中后端服务器的数量
    serverGroupId String
    服务器组ID
    status String
    服务器组的状态
    id string
    The provider-assigned unique ID for this managed resource.
    relatedLoadBalancerIds string[]
    服务器组关联的NLB实例
    serverCount number
    服务器组中后端服务器的数量
    serverGroupId string
    服务器组ID
    status string
    服务器组的状态
    id str
    The provider-assigned unique ID for this managed resource.
    related_load_balancer_ids Sequence[str]
    服务器组关联的NLB实例
    server_count int
    服务器组中后端服务器的数量
    server_group_id str
    服务器组ID
    status str
    服务器组的状态
    id String
    The provider-assigned unique ID for this managed resource.
    relatedLoadBalancerIds List<String>
    服务器组关联的NLB实例
    serverCount Number
    服务器组中后端服务器的数量
    serverGroupId String
    服务器组ID
    status String
    服务器组的状态

    Look up Existing NlbServerGroup Resource

    Get an existing NlbServerGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NlbServerGroupState, opts?: CustomResourceOptions): NlbServerGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        any_port_enabled: Optional[bool] = None,
        bypass_security_group_enabled: Optional[bool] = None,
        connection_drain_enabled: Optional[bool] = None,
        connection_drain_timeout: Optional[int] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        health_check: Optional[NlbServerGroupHealthCheckArgs] = None,
        ip_address_version: Optional[str] = None,
        preserve_client_ip_enabled: Optional[bool] = None,
        project_name: Optional[str] = None,
        protocol: Optional[str] = None,
        proxy_protocol_type: Optional[str] = None,
        related_load_balancer_ids: Optional[Sequence[str]] = None,
        scheduler: Optional[str] = None,
        server_count: Optional[int] = None,
        server_group_id: Optional[str] = None,
        server_group_name: Optional[str] = None,
        servers: Optional[Sequence[NlbServerGroupServerArgs]] = None,
        session_persistence_enabled: Optional[bool] = None,
        session_persistence_timeout: Optional[int] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[NlbServerGroupTagArgs]] = None,
        timestamp_remove_enabled: Optional[bool] = None,
        type: Optional[str] = None,
        updated_time: Optional[str] = None,
        vpc_id: Optional[str] = None) -> NlbServerGroup
    func GetNlbServerGroup(ctx *Context, name string, id IDInput, state *NlbServerGroupState, opts ...ResourceOption) (*NlbServerGroup, error)
    public static NlbServerGroup Get(string name, Input<string> id, NlbServerGroupState? state, CustomResourceOptions? opts = null)
    public static NlbServerGroup get(String name, Output<String> id, NlbServerGroupState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:clb:NlbServerGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    账号ID
    AnyPortEnabled bool
    是否开启全端口转发
    BypassSecurityGroupEnabled bool
    是否开启放通后端安全组功能。仅参数Type为“instance”时，可以配置此参数
    ConnectionDrainEnabled bool
    是否开启连接优雅中断
    ConnectionDrainTimeout int
    连接优雅中断超时时间，取值范围为0～900秒。参数ConnectionDrainEnabled为“true”时，该参数为必填。
    CreatedTime string
    后端服务器组的创建时间
    Description string
    后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头，可包含以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为0 ～ 255个字符。该参数不传入，则默认为空字符串。
    HealthCheck Volcengine.NlbServerGroupHealthCheck
    健康检查相关参数
    IpAddressVersion string
    服务器组的IP地址类型
    PreserveClientIpEnabled bool
    是否开启源地址保持
    ProjectName string
    项目名称
    Protocol string
    NLB转发流量到后端服务器时使用的通信协议
    ProxyProtocolType string
    是否开启Proxy-Protocol协议
    RelatedLoadBalancerIds List<string>
    服务器组关联的NLB实例
    Scheduler string
    NLB转发流量时遵循的规则
    ServerCount int
    服务器组中后端服务器的数量
    ServerGroupId string
    服务器组ID
    ServerGroupName string
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    Servers List<Volcengine.NlbServerGroupServer>
    SessionPersistenceEnabled bool
    是否开启会话保持
    SessionPersistenceTimeout int
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    Status string
    服务器组的状态
    Tags List<Volcengine.NlbServerGroupTag>
    TimestampRemoveEnabled bool
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    Type string
    服务器组的类型
    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 NlbServerGroupHealthCheckArgs
    健康检查相关参数
    IpAddressVersion string
    服务器组的IP地址类型
    PreserveClientIpEnabled bool
    是否开启源地址保持
    ProjectName string
    项目名称
    Protocol string
    NLB转发流量到后端服务器时使用的通信协议
    ProxyProtocolType string
    是否开启Proxy-Protocol协议
    RelatedLoadBalancerIds []string
    服务器组关联的NLB实例
    Scheduler string
    NLB转发流量时遵循的规则
    ServerCount int
    服务器组中后端服务器的数量
    ServerGroupId string
    服务器组ID
    ServerGroupName string
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    Servers []NlbServerGroupServerArgs
    SessionPersistenceEnabled bool
    是否开启会话保持
    SessionPersistenceTimeout int
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    Status string
    服务器组的状态
    Tags []NlbServerGroupTagArgs
    TimestampRemoveEnabled bool
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    Type string
    服务器组的类型
    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 NlbServerGroupHealthCheck
    健康检查相关参数
    ipAddressVersion String
    服务器组的IP地址类型
    preserveClientIpEnabled Boolean
    是否开启源地址保持
    projectName String
    项目名称
    protocol String
    NLB转发流量到后端服务器时使用的通信协议
    proxyProtocolType String
    是否开启Proxy-Protocol协议
    relatedLoadBalancerIds List<String>
    服务器组关联的NLB实例
    scheduler String
    NLB转发流量时遵循的规则
    serverCount Integer
    服务器组中后端服务器的数量
    serverGroupId String
    服务器组ID
    serverGroupName String
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    servers List<NlbServerGroupServer>
    sessionPersistenceEnabled Boolean
    是否开启会话保持
    sessionPersistenceTimeout Integer
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    status String
    服务器组的状态
    tags List<NlbServerGroupTag>
    timestampRemoveEnabled Boolean
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    type String
    服务器组的类型
    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 NlbServerGroupHealthCheck
    健康检查相关参数
    ipAddressVersion string
    服务器组的IP地址类型
    preserveClientIpEnabled boolean
    是否开启源地址保持
    projectName string
    项目名称
    protocol string
    NLB转发流量到后端服务器时使用的通信协议
    proxyProtocolType string
    是否开启Proxy-Protocol协议
    relatedLoadBalancerIds string[]
    服务器组关联的NLB实例
    scheduler string
    NLB转发流量时遵循的规则
    serverCount number
    服务器组中后端服务器的数量
    serverGroupId string
    服务器组ID
    serverGroupName string
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    servers NlbServerGroupServer[]
    sessionPersistenceEnabled boolean
    是否开启会话保持
    sessionPersistenceTimeout number
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    status string
    服务器组的状态
    tags NlbServerGroupTag[]
    timestampRemoveEnabled boolean
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    type string
    服务器组的类型
    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 NlbServerGroupHealthCheckArgs
    健康检查相关参数
    ip_address_version str
    服务器组的IP地址类型
    preserve_client_ip_enabled bool
    是否开启源地址保持
    project_name str
    项目名称
    protocol str
    NLB转发流量到后端服务器时使用的通信协议
    proxy_protocol_type str
    是否开启Proxy-Protocol协议
    related_load_balancer_ids Sequence[str]
    服务器组关联的NLB实例
    scheduler str
    NLB转发流量时遵循的规则
    server_count int
    服务器组中后端服务器的数量
    server_group_id str
    服务器组ID
    server_group_name str
    服务器组名称, 必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。该参数不传入，则默认为服务器组ID。
    servers Sequence[NlbServerGroupServerArgs]
    session_persistence_enabled bool
    是否开启会话保持
    session_persistence_timeout int
    会话保持的超时时间，取值范围为1～3600秒，默认1000秒
    status str
    服务器组的状态
    tags Sequence[NlbServerGroupTagArgs]
    timestamp_remove_enabled bool
    是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能
    type str
    服务器组的类型
    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
    健康检查相关参数
    ipAddressVersion String
    服务器组的IP地址类型
    preserveClientIpEnabled Boolean
    是否开启源地址保持
    projectName String
    项目名称
    protocol String
    NLB转发流量到后端服务器时使用的通信协议
    proxyProtocolType String
    是否开启Proxy-Protocol协议
    relatedLoadBalancerIds List<String>
    服务器组关联的NLB实例
    scheduler String
    NLB转发流量时遵循的规则
    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
    服务器组的类型
    updatedTime String
    后端服务器组的更新时间
    vpcId String
    服务器组所属私有网络的ID。

    Supporting Types

    NlbServerGroupHealthCheck, NlbServerGroupHealthCheckArgs

    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
    健康检查的协议类型
    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
    健康检查的协议类型
    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
    健康检查的协议类型
    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
    健康检查的协议类型
    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
    健康检查的协议类型
    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
    健康检查的协议类型
    udpExpect String
    UDP健康检查的请求字符串。只允许包含字母和数字，最大长度限制为64个字符。
    udpRequest String
    UDP健康检查的预期响应字符串
    unhealthyThreshold Number
    健康检查的不健康阈值，取值范围为2 ～ 10次，默认值为3次。连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查异常。
    uri String
    健康检查的路径

    NlbServerGroupServer, NlbServerGroupServerArgs

    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
    后端服务器的类型
    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
    后端服务器的类型
    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
    后端服务器的类型
    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
    后端服务器的类型
    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
    后端服务器的类型
    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
    后端服务器的类型
    weight Number
    后端服务器的权重，取值范围为0 ～ 100。权重为0，表示不会将请求转发给该服务器。该参数不传入，则默认为0
    zoneId String
    指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时，此参数必填。NLB实例开启跨可用区转发功能时，该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时，则该后端服务器仅接收来自指定可用区的流量。

    NlbServerGroupTag, NlbServerGroupTagArgs

    Key string
    标签键
    Value string
    标签值
    Key string
    标签键
    Value string
    标签值
    key String
    标签键
    value String
    标签值
    key string
    标签键
    value string
    标签值
    key str
    标签键
    value str
    标签值
    key String
    标签键
    value String
    标签值

    Import

    $ pulumi import volcenginecc:clb/nlbServerGroup:NlbServerGroup example "server_group_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine
    volcengine/pulumi-volcenginecc
      Meet Neo: Your AI Platform Teammate