服务器组是一组后端服务器。
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
nLBServerGroupDemo:
type: bytepluscc: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,
proxy_protocol_type: Optional[str] = None,
scheduler: 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,
connection_drain_enabled: Optional[bool] = None,
any_port_enabled: Optional[bool] = None,
connection_drain_timeout: Optional[int] = 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,
bypass_security_group_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: bytepluscc: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 Bytepluscc.Clb.NlbServerGroup("nlbServerGroupResource", new()
{
Protocol = "string",
VpcId = "string",
ProxyProtocolType = "string",
Scheduler = "string",
Description = "string",
HealthCheck = new Bytepluscc.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,
ProjectName = "string",
ConnectionDrainEnabled = false,
AnyPortEnabled = false,
ConnectionDrainTimeout = 0,
ServerGroupName = "string",
Servers = new[]
{
new Bytepluscc.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 Bytepluscc.Clb.Inputs.NlbServerGroupTagArgs
{
Key = "string",
Value = "string",
},
},
TimestampRemoveEnabled = false,
Type = "string",
BypassSecurityGroupEnabled = false,
});
example, err := clb.NewNlbServerGroup(ctx, "nlbServerGroupResource", &clb.NlbServerGroupArgs{
Protocol: pulumi.String("string"),
VpcId: pulumi.String("string"),
ProxyProtocolType: pulumi.String("string"),
Scheduler: 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),
ProjectName: pulumi.String("string"),
ConnectionDrainEnabled: pulumi.Bool(false),
AnyPortEnabled: pulumi.Bool(false),
ConnectionDrainTimeout: pulumi.Int(0),
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"),
BypassSecurityGroupEnabled: pulumi.Bool(false),
})
var nlbServerGroupResource = new NlbServerGroup("nlbServerGroupResource", NlbServerGroupArgs.builder()
.protocol("string")
.vpcId("string")
.proxyProtocolType("string")
.scheduler("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)
.projectName("string")
.connectionDrainEnabled(false)
.anyPortEnabled(false)
.connectionDrainTimeout(0)
.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")
.bypassSecurityGroupEnabled(false)
.build());
nlb_server_group_resource = bytepluscc.clb.NlbServerGroup("nlbServerGroupResource",
protocol="string",
vpc_id="string",
proxy_protocol_type="string",
scheduler="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,
project_name="string",
connection_drain_enabled=False,
any_port_enabled=False,
connection_drain_timeout=0,
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",
bypass_security_group_enabled=False)
const nlbServerGroupResource = new bytepluscc.clb.NlbServerGroup("nlbServerGroupResource", {
protocol: "string",
vpcId: "string",
proxyProtocolType: "string",
scheduler: "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",
connectionDrainEnabled: false,
anyPortEnabled: false,
connectionDrainTimeout: 0,
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",
bypassSecurityGroupEnabled: false,
});
type: bytepluscc:clb:NlbServerGroup
properties:
anyPortEnabled: false
bypassSecurityGroupEnabled: false
connectionDrainEnabled: false
connectionDrainTimeout: 0
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
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转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- Vpc
Id string - 服务器组所属私有网络的ID。
- Any
Port boolEnabled - 是否开启全端口转发。
- Bypass
Security boolGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- Connection
Drain boolEnabled - 是否开启连接优雅中断。
- Connection
Drain intTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- Description string
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- Health
Check Byteplus.Nlb Server Group Health Check - 健康检查相关参数。
- Ip
Address stringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- Preserve
Client boolIp Enabled - 是否开启源地址保持。
- Project
Name string - 项目名称。
- Proxy
Protocol stringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- Scheduler string
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- Server
Group stringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- Servers
List<Byteplus.
Nlb Server Group Server> - Session
Persistence boolEnabled - 是否开启会话保持。
- Session
Persistence intTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
-
List<Byteplus.
Nlb Server Group Tag> - Timestamp
Remove boolEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- Type string
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- Protocol string
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- Vpc
Id string - 服务器组所属私有网络的ID。
- Any
Port boolEnabled - 是否开启全端口转发。
- Bypass
Security boolGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- Connection
Drain boolEnabled - 是否开启连接优雅中断。
- Connection
Drain intTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- Description string
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- Health
Check NlbServer Group Health Check Args - 健康检查相关参数。
- Ip
Address stringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- Preserve
Client boolIp Enabled - 是否开启源地址保持。
- Project
Name string - 项目名称。
- Proxy
Protocol stringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- Scheduler string
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- Server
Group stringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- Servers
[]Nlb
Server Group Server Args - Session
Persistence boolEnabled - 是否开启会话保持。
- Session
Persistence intTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
-
[]Nlb
Server Group Tag Args - Timestamp
Remove boolEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- Type string
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- protocol String
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- vpc
Id String - 服务器组所属私有网络的ID。
- any
Port BooleanEnabled - 是否开启全端口转发。
- bypass
Security BooleanGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- connection
Drain BooleanEnabled - 是否开启连接优雅中断。
- connection
Drain IntegerTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- description String
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- health
Check NlbServer Group Health Check - 健康检查相关参数。
- ip
Address StringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- preserve
Client BooleanIp Enabled - 是否开启源地址保持。
- project
Name String - 项目名称。
- proxy
Protocol StringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- scheduler String
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- server
Group StringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- servers
List<Nlb
Server Group Server> - session
Persistence BooleanEnabled - 是否开启会话保持。
- session
Persistence IntegerTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
-
List<Nlb
Server Group Tag> - timestamp
Remove BooleanEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- type String
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- protocol string
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- vpc
Id string - 服务器组所属私有网络的ID。
- any
Port booleanEnabled - 是否开启全端口转发。
- bypass
Security booleanGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- connection
Drain booleanEnabled - 是否开启连接优雅中断。
- connection
Drain numberTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- description string
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- health
Check NlbServer Group Health Check - 健康检查相关参数。
- ip
Address stringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- preserve
Client booleanIp Enabled - 是否开启源地址保持。
- project
Name string - 项目名称。
- proxy
Protocol stringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- scheduler string
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- server
Group stringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- servers
Nlb
Server Group Server[] - session
Persistence booleanEnabled - 是否开启会话保持。
- session
Persistence numberTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
-
Nlb
Server Group Tag[] - timestamp
Remove booleanEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- type string
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- protocol str
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- vpc_
id str - 服务器组所属私有网络的ID。
- any_
port_ boolenabled - 是否开启全端口转发。
- bypass_
security_ boolgroup_ enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- connection_
drain_ boolenabled - 是否开启连接优雅中断。
- connection_
drain_ inttimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- description str
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- health_
check NlbServer Group Health Check Args - 健康检查相关参数。
- ip_
address_ strversion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- preserve_
client_ boolip_ enabled - 是否开启源地址保持。
- project_
name str - 项目名称。
- proxy_
protocol_ strtype - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- scheduler str
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- server_
group_ strname - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- servers
Sequence[Nlb
Server Group Server Args] - session_
persistence_ boolenabled - 是否开启会话保持。
- session_
persistence_ inttimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
-
Sequence[Nlb
Server Group Tag Args] - timestamp_
remove_ boolenabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- type str
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- protocol String
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- vpc
Id String - 服务器组所属私有网络的ID。
- any
Port BooleanEnabled - 是否开启全端口转发。
- bypass
Security BooleanGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- connection
Drain BooleanEnabled - 是否开启连接优雅中断。
- connection
Drain NumberTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- description String
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- health
Check Property Map - 健康检查相关参数。
- ip
Address StringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- preserve
Client BooleanIp Enabled - 是否开启源地址保持。
- project
Name String - 项目名称。
- proxy
Protocol StringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- scheduler String
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- server
Group StringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- servers List<Property Map>
- session
Persistence BooleanEnabled - 是否开启会话保持。
- session
Persistence NumberTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
- List<Property Map>
- timestamp
Remove BooleanEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- type String
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
Outputs
All input properties are implicitly available as output properties. Additionally, the NlbServerGroup resource produces the following output properties:
- Account
Id string - 账号ID。
- Created
Time string - 后端服务器组的创建时间。
- Id string
- The provider-assigned unique ID for this managed resource.
- List<string>
- 服务器组关联的NLB实例。
- Server
Count int - 服务器组中后端服务器的数量。
- Server
Group stringId - 服务器组ID。
- Status string
- 服务器组的状态。
- Updated
Time string - 后端服务器组的更新时间。
- Account
Id string - 账号ID。
- Created
Time string - 后端服务器组的创建时间。
- Id string
- The provider-assigned unique ID for this managed resource.
- []string
- 服务器组关联的NLB实例。
- Server
Count int - 服务器组中后端服务器的数量。
- Server
Group stringId - 服务器组ID。
- Status string
- 服务器组的状态。
- Updated
Time string - 后端服务器组的更新时间。
- account
Id String - 账号ID。
- created
Time String - 后端服务器组的创建时间。
- id String
- The provider-assigned unique ID for this managed resource.
- List<String>
- 服务器组关联的NLB实例。
- server
Count Integer - 服务器组中后端服务器的数量。
- server
Group StringId - 服务器组ID。
- status String
- 服务器组的状态。
- updated
Time String - 后端服务器组的更新时间。
- account
Id string - 账号ID。
- created
Time string - 后端服务器组的创建时间。
- id string
- The provider-assigned unique ID for this managed resource.
- string[]
- 服务器组关联的NLB实例。
- server
Count number - 服务器组中后端服务器的数量。
- server
Group stringId - 服务器组ID。
- status string
- 服务器组的状态。
- updated
Time string - 后端服务器组的更新时间。
- account_
id str - 账号ID。
- created_
time str - 后端服务器组的创建时间。
- id str
- The provider-assigned unique ID for this managed resource.
- Sequence[str]
- 服务器组关联的NLB实例。
- server_
count int - 服务器组中后端服务器的数量。
- server_
group_ strid - 服务器组ID。
- status str
- 服务器组的状态。
- updated_
time str - 后端服务器组的更新时间。
- account
Id String - 账号ID。
- created
Time String - 后端服务器组的创建时间。
- id String
- The provider-assigned unique ID for this managed resource.
- List<String>
- 服务器组关联的NLB实例。
- server
Count Number - 服务器组中后端服务器的数量。
- server
Group StringId - 服务器组ID。
- status String
- 服务器组的状态。
- updated
Time 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) -> NlbServerGroupfunc 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: bytepluscc: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.
- Account
Id string - 账号ID。
- Any
Port boolEnabled - 是否开启全端口转发。
- Bypass
Security boolGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- Connection
Drain boolEnabled - 是否开启连接优雅中断。
- Connection
Drain intTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- Created
Time string - 后端服务器组的创建时间。
- Description string
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- Health
Check Byteplus.Nlb Server Group Health Check - 健康检查相关参数。
- Ip
Address stringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- Preserve
Client boolIp Enabled - 是否开启源地址保持。
- Project
Name string - 项目名称。
- Protocol string
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- Proxy
Protocol stringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- List<string>
- 服务器组关联的NLB实例。
- Scheduler string
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- Server
Count int - 服务器组中后端服务器的数量。
- Server
Group stringId - 服务器组ID。
- Server
Group stringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- Servers
List<Byteplus.
Nlb Server Group Server> - Session
Persistence boolEnabled - 是否开启会话保持。
- Session
Persistence intTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
- Status string
- 服务器组的状态。
-
List<Byteplus.
Nlb Server Group Tag> - Timestamp
Remove boolEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- Type string
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- Updated
Time string - 后端服务器组的更新时间。
- Vpc
Id string - 服务器组所属私有网络的ID。
- Account
Id string - 账号ID。
- Any
Port boolEnabled - 是否开启全端口转发。
- Bypass
Security boolGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- Connection
Drain boolEnabled - 是否开启连接优雅中断。
- Connection
Drain intTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- Created
Time string - 后端服务器组的创建时间。
- Description string
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- Health
Check NlbServer Group Health Check Args - 健康检查相关参数。
- Ip
Address stringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- Preserve
Client boolIp Enabled - 是否开启源地址保持。
- Project
Name string - 项目名称。
- Protocol string
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- Proxy
Protocol stringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- []string
- 服务器组关联的NLB实例。
- Scheduler string
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- Server
Count int - 服务器组中后端服务器的数量。
- Server
Group stringId - 服务器组ID。
- Server
Group stringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- Servers
[]Nlb
Server Group Server Args - Session
Persistence boolEnabled - 是否开启会话保持。
- Session
Persistence intTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
- Status string
- 服务器组的状态。
-
[]Nlb
Server Group Tag Args - Timestamp
Remove boolEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- Type string
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- Updated
Time string - 后端服务器组的更新时间。
- Vpc
Id string - 服务器组所属私有网络的ID。
- account
Id String - 账号ID。
- any
Port BooleanEnabled - 是否开启全端口转发。
- bypass
Security BooleanGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- connection
Drain BooleanEnabled - 是否开启连接优雅中断。
- connection
Drain IntegerTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- created
Time String - 后端服务器组的创建时间。
- description String
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- health
Check NlbServer Group Health Check - 健康检查相关参数。
- ip
Address StringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- preserve
Client BooleanIp Enabled - 是否开启源地址保持。
- project
Name String - 项目名称。
- protocol String
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- proxy
Protocol StringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- List<String>
- 服务器组关联的NLB实例。
- scheduler String
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- server
Count Integer - 服务器组中后端服务器的数量。
- server
Group StringId - 服务器组ID。
- server
Group StringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- servers
List<Nlb
Server Group Server> - session
Persistence BooleanEnabled - 是否开启会话保持。
- session
Persistence IntegerTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
- status String
- 服务器组的状态。
-
List<Nlb
Server Group Tag> - timestamp
Remove BooleanEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- type String
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- updated
Time String - 后端服务器组的更新时间。
- vpc
Id String - 服务器组所属私有网络的ID。
- account
Id string - 账号ID。
- any
Port booleanEnabled - 是否开启全端口转发。
- bypass
Security booleanGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- connection
Drain booleanEnabled - 是否开启连接优雅中断。
- connection
Drain numberTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- created
Time string - 后端服务器组的创建时间。
- description string
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- health
Check NlbServer Group Health Check - 健康检查相关参数。
- ip
Address stringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- preserve
Client booleanIp Enabled - 是否开启源地址保持。
- project
Name string - 项目名称。
- protocol string
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- proxy
Protocol stringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- string[]
- 服务器组关联的NLB实例。
- scheduler string
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- server
Count number - 服务器组中后端服务器的数量。
- server
Group stringId - 服务器组ID。
- server
Group stringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- servers
Nlb
Server Group Server[] - session
Persistence booleanEnabled - 是否开启会话保持。
- session
Persistence numberTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
- status string
- 服务器组的状态。
-
Nlb
Server Group Tag[] - timestamp
Remove booleanEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- type string
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- updated
Time string - 后端服务器组的更新时间。
- vpc
Id string - 服务器组所属私有网络的ID。
- account_
id str - 账号ID。
- any_
port_ boolenabled - 是否开启全端口转发。
- bypass_
security_ boolgroup_ enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- connection_
drain_ boolenabled - 是否开启连接优雅中断。
- connection_
drain_ inttimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- created_
time str - 后端服务器组的创建时间。
- description str
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- health_
check NlbServer Group Health Check Args - 健康检查相关参数。
- ip_
address_ strversion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- preserve_
client_ boolip_ enabled - 是否开启源地址保持。
- project_
name str - 项目名称。
- protocol str
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- proxy_
protocol_ strtype - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- Sequence[str]
- 服务器组关联的NLB实例。
- scheduler str
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- server_
count int - 服务器组中后端服务器的数量。
- server_
group_ strid - 服务器组ID。
- server_
group_ strname - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- servers
Sequence[Nlb
Server Group Server Args] - session_
persistence_ boolenabled - 是否开启会话保持。
- session_
persistence_ inttimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
- status str
- 服务器组的状态。
-
Sequence[Nlb
Server Group Tag Args] - timestamp_
remove_ boolenabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- type str
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- updated_
time str - 后端服务器组的更新时间。
- vpc_
id str - 服务器组所属私有网络的ID。
- account
Id String - 账号ID。
- any
Port BooleanEnabled - 是否开启全端口转发。
- bypass
Security BooleanGroup Enabled - 是否开启放通后端安全组功能。仅参数Type为“instance”时,可以配置此参数。
- connection
Drain BooleanEnabled - 是否开启连接优雅中断。
- connection
Drain NumberTimeout - 连接优雅中断超时时间,取值范围为0~900秒。参数ConnectionDrainEnabled为“true”时,该参数为必填。
- created
Time String - 后端服务器组的创建时间。
- description String
- 后端服务器组的描述,服务器组的描述。必须以字母、数字或中文开头,可包含以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)长度限制为0 ~ 255个字符。该参数不传入,则默认为空字符串。
- health
Check Property Map - 健康检查相关参数。
- ip
Address StringVersion - 服务器组的IP地址类型。取值如下:ipv4(默认值):表示该服务器组仅支持添加IPv4类型的后端服务器。ipv6:表示该服务器组仅支持添加IPv6类型的后端服务器。
- preserve
Client BooleanIp Enabled - 是否开启源地址保持。
- project
Name String - 项目名称。
- protocol String
- NLB转发流量到后端服务器时使用的通信协议。取值如下:TCP。UDP。
- proxy
Protocol StringType - 是否开启Proxy-Protocol协议。取值如下:off(默认值):关闭。standard:开启。NLB将通过Proxy-Protocol协议携带客户端源IP地址转发至后端服务器,还需要在后端服务器上配置Proxy-Protocol。
- List<String>
- 服务器组关联的NLB实例。
- scheduler String
- NLB转发流量时遵循的规则。取值如下:wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的次数(概率)越高。wlc:加权最小连接数,在最少连接数的基础上,根据后端服务器的不同处理能力,给每个服务器分配不同的权重,使其能够接受相应权值数的服务请求。sh:源地址哈希,基于源IP地址的一致性哈希,相同的源地址会调度到相同的后端服务器。
- server
Count Number - 服务器组中后端服务器的数量。
- server
Group StringId - 服务器组ID。
- server
Group StringName - 服务器组名称, 必须以字母、数字或中文开头,可包含以下特殊字符:点号(.)、下划线(_)和中划线(-)。限制为1 ~ 128个字符。该参数不传入,则默认为服务器组ID。
- servers List<Property Map>
- session
Persistence BooleanEnabled - 是否开启会话保持。
- session
Persistence NumberTimeout - 会话保持的超时时间,取值范围为1~3600秒,默认1000秒。
- status String
- 服务器组的状态。
- List<Property Map>
- timestamp
Remove BooleanEnabled - 是否开启清除TCP/HTTP/HTTPS报文的timestamp(即时间戳)的功能。
- type String
- 服务器组的类型。取值如下:instance(默认值):服务器类型。支持添加云服务器实例和已绑定云服务器实例的辅助网卡作为后端服务器。ip:IP地址类型。支持添加任何网络可达的VPC或IDC中的服务器作为后端服务器。
- updated
Time String - 后端服务器组的更新时间。
- vpc
Id String - 服务器组所属私有网络的ID。
Supporting Types
NlbServerGroupHealthCheck, NlbServerGroupHealthCheckArgs
- Domain string
- 健康检查的域名。
- Enabled bool
- 是否开启健康检查。
- Healthy
Threshold int - 健康检查的健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“正常”的后端服务器将被判定为健康检查“正常”。
- Http
Code string - 健康检查正常的HTTP状态码。
- Interval int
- 健康检查的时间间隔,取值范围为1 ~ 300秒,默认值为10秒。
- Method string
- 健康检查的请求方法。
- Port int
- 健康检查的端口,取值范围 1~65535。服务器组未开启全端口转发时,该参数默认为0,表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时,必须指定该参数。
- Timeout int
- 健康检查的响应超时时间,取值范围为1 ~ 60秒,默认值为3秒。如果后端服务器在指定时间内没有正确响应,则判定为健康检查“异常”。
- Type string
- 健康检查的协议类型。取值如下:取值如下:TCP(默认值)、HTTP、UDP
- Udp
Expect string - UDP健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字符。
- Udp
Request string - UDP健康检查的预期响应字符串。
- Unhealthy
Threshold int - 健康检查的不健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“异常”的后端服务器将被判定为健康检查异常。
- Uri string
- 健康检查的路径。
- Domain string
- 健康检查的域名。
- Enabled bool
- 是否开启健康检查。
- Healthy
Threshold int - 健康检查的健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“正常”的后端服务器将被判定为健康检查“正常”。
- Http
Code string - 健康检查正常的HTTP状态码。
- Interval int
- 健康检查的时间间隔,取值范围为1 ~ 300秒,默认值为10秒。
- Method string
- 健康检查的请求方法。
- Port int
- 健康检查的端口,取值范围 1~65535。服务器组未开启全端口转发时,该参数默认为0,表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时,必须指定该参数。
- Timeout int
- 健康检查的响应超时时间,取值范围为1 ~ 60秒,默认值为3秒。如果后端服务器在指定时间内没有正确响应,则判定为健康检查“异常”。
- Type string
- 健康检查的协议类型。取值如下:取值如下:TCP(默认值)、HTTP、UDP
- Udp
Expect string - UDP健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字符。
- Udp
Request string - UDP健康检查的预期响应字符串。
- Unhealthy
Threshold int - 健康检查的不健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“异常”的后端服务器将被判定为健康检查异常。
- Uri string
- 健康检查的路径。
- domain String
- 健康检查的域名。
- enabled Boolean
- 是否开启健康检查。
- healthy
Threshold Integer - 健康检查的健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“正常”的后端服务器将被判定为健康检查“正常”。
- http
Code String - 健康检查正常的HTTP状态码。
- interval Integer
- 健康检查的时间间隔,取值范围为1 ~ 300秒,默认值为10秒。
- method String
- 健康检查的请求方法。
- port Integer
- 健康检查的端口,取值范围 1~65535。服务器组未开启全端口转发时,该参数默认为0,表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时,必须指定该参数。
- timeout Integer
- 健康检查的响应超时时间,取值范围为1 ~ 60秒,默认值为3秒。如果后端服务器在指定时间内没有正确响应,则判定为健康检查“异常”。
- type String
- 健康检查的协议类型。取值如下:取值如下:TCP(默认值)、HTTP、UDP
- udp
Expect String - UDP健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字符。
- udp
Request String - UDP健康检查的预期响应字符串。
- unhealthy
Threshold Integer - 健康检查的不健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“异常”的后端服务器将被判定为健康检查异常。
- uri String
- 健康检查的路径。
- domain string
- 健康检查的域名。
- enabled boolean
- 是否开启健康检查。
- healthy
Threshold number - 健康检查的健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“正常”的后端服务器将被判定为健康检查“正常”。
- http
Code string - 健康检查正常的HTTP状态码。
- interval number
- 健康检查的时间间隔,取值范围为1 ~ 300秒,默认值为10秒。
- method string
- 健康检查的请求方法。
- port number
- 健康检查的端口,取值范围 1~65535。服务器组未开启全端口转发时,该参数默认为0,表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时,必须指定该参数。
- timeout number
- 健康检查的响应超时时间,取值范围为1 ~ 60秒,默认值为3秒。如果后端服务器在指定时间内没有正确响应,则判定为健康检查“异常”。
- type string
- 健康检查的协议类型。取值如下:取值如下:TCP(默认值)、HTTP、UDP
- udp
Expect string - UDP健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字符。
- udp
Request string - UDP健康检查的预期响应字符串。
- unhealthy
Threshold number - 健康检查的不健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“异常”的后端服务器将被判定为健康检查异常。
- uri string
- 健康检查的路径。
- domain str
- 健康检查的域名。
- enabled bool
- 是否开启健康检查。
- healthy_
threshold int - 健康检查的健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“正常”的后端服务器将被判定为健康检查“正常”。
- http_
code str - 健康检查正常的HTTP状态码。
- interval int
- 健康检查的时间间隔,取值范围为1 ~ 300秒,默认值为10秒。
- method str
- 健康检查的请求方法。
- port int
- 健康检查的端口,取值范围 1~65535。服务器组未开启全端口转发时,该参数默认为0,表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时,必须指定该参数。
- timeout int
- 健康检查的响应超时时间,取值范围为1 ~ 60秒,默认值为3秒。如果后端服务器在指定时间内没有正确响应,则判定为健康检查“异常”。
- type str
- 健康检查的协议类型。取值如下:取值如下:TCP(默认值)、HTTP、UDP
- udp_
expect str - UDP健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字符。
- udp_
request str - UDP健康检查的预期响应字符串。
- unhealthy_
threshold int - 健康检查的不健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“异常”的后端服务器将被判定为健康检查异常。
- uri str
- 健康检查的路径。
- domain String
- 健康检查的域名。
- enabled Boolean
- 是否开启健康检查。
- healthy
Threshold Number - 健康检查的健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“正常”的后端服务器将被判定为健康检查“正常”。
- http
Code String - 健康检查正常的HTTP状态码。
- interval Number
- 健康检查的时间间隔,取值范围为1 ~ 300秒,默认值为10秒。
- method String
- 健康检查的请求方法。
- port Number
- 健康检查的端口,取值范围 1~65535。服务器组未开启全端口转发时,该参数默认为0,表示使用后端服务器的端口进行健康检查。服务器组开启全端口转发时,必须指定该参数。
- timeout Number
- 健康检查的响应超时时间,取值范围为1 ~ 60秒,默认值为3秒。如果后端服务器在指定时间内没有正确响应,则判定为健康检查“异常”。
- type String
- 健康检查的协议类型。取值如下:取值如下:TCP(默认值)、HTTP、UDP
- udp
Expect String - UDP健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字符。
- udp
Request String - UDP健康检查的预期响应字符串。
- unhealthy
Threshold Number - 健康检查的不健康阈值,取值范围为2 ~ 10次,默认值为3次。连续执行指定次数的健康检查,结果均为“异常”的后端服务器将被判定为健康检查异常。
- uri String
- 健康检查的路径。
NlbServerGroupServer, NlbServerGroupServerArgs
- Description string
- 后端服务器的描述,默认值为空字符串。
- Instance
Id 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。
- Server
Id string - 后端服务器 ID。
- Type string
- 后端服务器的类型。取值如下:ecs:云服务器实例(即主网卡)。eni:辅助网卡。ip:IP地址。
- Weight int
- 后端服务器的权重,取值范围为0 ~ 100。权重为0,表示不会将请求转发给该服务器。该参数不传入,则默认为0。
- Zone
Id string - 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时,此参数必填。NLB实例开启跨可用区转发功能时,该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时,则该后端服务器仅接收来自指定可用区的流量。
- Description string
- 后端服务器的描述,默认值为空字符串。
- Instance
Id 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。
- Server
Id string - 后端服务器 ID。
- Type string
- 后端服务器的类型。取值如下:ecs:云服务器实例(即主网卡)。eni:辅助网卡。ip:IP地址。
- Weight int
- 后端服务器的权重,取值范围为0 ~ 100。权重为0,表示不会将请求转发给该服务器。该参数不传入,则默认为0。
- Zone
Id string - 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时,此参数必填。NLB实例开启跨可用区转发功能时,该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时,则该后端服务器仅接收来自指定可用区的流量。
- description String
- 后端服务器的描述,默认值为空字符串。
- instance
Id 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。
- server
Id String - 后端服务器 ID。
- type String
- 后端服务器的类型。取值如下:ecs:云服务器实例(即主网卡)。eni:辅助网卡。ip:IP地址。
- weight Integer
- 后端服务器的权重,取值范围为0 ~ 100。权重为0,表示不会将请求转发给该服务器。该参数不传入,则默认为0。
- zone
Id String - 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时,此参数必填。NLB实例开启跨可用区转发功能时,该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时,则该后端服务器仅接收来自指定可用区的流量。
- description string
- 后端服务器的描述,默认值为空字符串。
- instance
Id 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。
- server
Id string - 后端服务器 ID。
- type string
- 后端服务器的类型。取值如下:ecs:云服务器实例(即主网卡)。eni:辅助网卡。ip:IP地址。
- weight number
- 后端服务器的权重,取值范围为0 ~ 100。权重为0,表示不会将请求转发给该服务器。该参数不传入,则默认为0。
- zone
Id string - 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时,此参数必填。NLB实例开启跨可用区转发功能时,该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时,则该后端服务器仅接收来自指定可用区的流量。
- description str
- 后端服务器的描述,默认值为空字符串。
- instance_
id str - 服务器实例的ID或IP地址。服务器类型为“ecs”时,传入云服务器实例的ID。您可以调用DescribeInstances接口云服务器实例ID。服务器类型为“eni”时,传入已绑定云服务器实例的网卡ID。您可以调用DescribeNetworkInterfaces接口获取网卡ID。服务器类型为“ip”时,传入后端服务器的IP地址。
- ip str
- 后端服务器的私网IP地址。您可以调用DescribeInstances接口获取“ecs”类型后端服务器的私网IP地址。您可以调用DescribeNetworkInterfaces接口获取“eni”类型后端服务器的私网IP地址。
- port int
- 后端服务器接收请求的端口号,取值范围为 1~65535。参数AnyPortEnabled为“false”,即服务器组未开启全端口转发时,该参数为必填。参数AnyPortEnabled为“true”,即服务器组开启全端口转发时,该参数默认为0。
- server_
id str - 后端服务器 ID。
- type str
- 后端服务器的类型。取值如下:ecs:云服务器实例(即主网卡)。eni:辅助网卡。ip:IP地址。
- weight int
- 后端服务器的权重,取值范围为0 ~ 100。权重为0,表示不会将请求转发给该服务器。该参数不传入,则默认为0。
- zone_
id str - 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时,此参数必填。NLB实例开启跨可用区转发功能时,该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时,则该后端服务器仅接收来自指定可用区的流量。
- description String
- 后端服务器的描述,默认值为空字符串。
- instance
Id 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。
- server
Id String - 后端服务器 ID。
- type String
- 后端服务器的类型。取值如下:ecs:云服务器实例(即主网卡)。eni:辅助网卡。ip:IP地址。
- weight Number
- 后端服务器的权重,取值范围为0 ~ 100。权重为0,表示不会将请求转发给该服务器。该参数不传入,则默认为0。
- zone
Id String - 指定后端服务器关联的NLB实例可用区。当参数Servers.N.Type为ip时,此参数必填。NLB实例开启跨可用区转发功能时,该后端服务器可以接收来自NLB实例所有可用区的流量。NLB实例关闭跨可用区转发功能时,则该后端服务器仅接收来自指定可用区的流量。
NlbServerGroupTag, NlbServerGroupTagArgs
Import
$ pulumi import bytepluscc:clb/nlbServerGroup:NlbServerGroup example "server_group_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
