types
AttachedTargetGroup
An AttachedTargetGroup resource. For more information, see Targets and groups.
targetGroupId : string
ID of the target group.
healthChecks : HealthCheck
A health check to perform on the target group. For now we accept only one health check per AttachedTargetGroup.
HealthCheck
A HealthCheck resource. For more information, see Health check.
TcpOptions
Configuration option for a TCP health check.
port : int64
Port to use for TCP health checks.
HttpOptions
Configuration option for an HTTP health check.
port : int64
Port to use for HTTP health checks.
path : string
URL path to set for health checking requests for every target in the target group.
For example /ping. The default path is /.
name : string
Name of the health check. The name must be unique for each target group that attached to a single load balancer. 3-63 characters long.
interval : google.protobuf.Duration
The interval between health checks. The default is 2 seconds.
timeout : google.protobuf.Duration
Timeout for a target to return a response for the health check. The default is 1 second.
unhealthyThreshold : int64
Number of failed health checks before changing the status to UNHEALTHY. The default is 2.
healthyThreshold : int64
Number of successful health checks required in order to set the HEALTHY status for the target. The default is 2.
One of options
Protocol to use for the health check. Either TCP or HTTP.
tcpOptions: TcpOptionsOptions for TCP health check.
httpOptions: HttpOptionsOptions for HTTP health check.
Listener
A Listener resource. For more information, see Listener
Protocol
Network protocol to use.
PROTOCOL_UNSPECIFIEDNetwork protocol to use.
TCPNetwork protocol to use.
UDPNetwork protocol to use.
name : string
Name of the listener. The name must be unique for each listener on a single load balancer. 3-63 characters long.
address : string
IP address for the listener.
port : int64
Port.
protocol : Protocol
Network protocol for incoming traffic.
targetPort : int64
Port of a target.
subnetId : string
ID of the subnet.
ipVersion : IpVersion
IP version of the external address.
NetworkLoadBalancer
A NetworkLoadBalancer resource. For more information, see Network Load Balancer.
Status
STATUS_UNSPECIFIEDCREATINGNetwork load balancer is being created.
STARTINGNetwork load balancer is being started.
ACTIVENetwork load balancer is active and sends traffic to the targets.
STOPPINGNetwork load balancer is being stopped.
STOPPEDNetwork load balancer is stopped and doesn't send traffic to the targets.
DELETINGNetwork load balancer is being deleted.
INACTIVEThe load balancer doesn't have any listeners or target groups, or attached target groups are empty. The load balancer doesn't perform any health checks or send traffic in this state.
Type
TYPE_UNSPECIFIEDEXTERNALExternal network load balancer.
INTERNALInternal network load balancer.
SessionAffinity
Type of session affinity. Only 5-tuple affinity is currently available. For more information, see Load Balancer concepts.
SESSION_AFFINITY_UNSPECIFIEDType of session affinity. Only 5-tuple affinity is currently available. For more information, see Load Balancer concepts.
CLIENT_IP_PORT_PROTO5-tuple affinity.
id : string
ID of the network load balancer.
folderId : string
ID of the folder that the network load balancer belongs to.
createdAt : google.protobuf.Timestamp
Creation timestamp in RFC3339 text format.
name : string
Name of the network load balancer. The name is unique within the folder. 3-63 characters long.
description : string
Optional description of the network load balancer. 0-256 characters long.
labels : string
Resource labels as key:value pairs. Maximum of 64 per resource.
regionId : string
ID of the region that the network load balancer belongs to.
status : Status
Status of the network load balancer.
type : Type
Type of the network load balancer. Only external network load balancers are available now.
sessionAffinity : SessionAffinity
Type of the session affinity. Only 5-tuple affinity is available now.
listeners : Listener
List of listeners for the network load balancer.
attachedTargetGroups : AttachedTargetGroup
List of target groups attached to the network load balancer.
deletionProtection : bool
Specifies if network load balancer protected from deletion.
Target
A Target resource. For more information, see Target groups and resources.
subnetId : string
ID of the subnet that targets are connected to. All targets in the target group must be connected to the same subnet within a single availability zone.
address : string
IP address of the target.
TargetGroup
A TargetGroup resource. For more information, see Target groups and resources.
id : string
Output only. ID of the target group.
folderId : string
ID of the folder that the target group belongs to.
createdAt : google.protobuf.Timestamp
Output only. Creation timestamp in RFC3339 text format.
name : string
Name of the target group. The name is unique within the folder. 3-63 characters long.
description : string
Description of the target group. 0-256 characters long.
labels : string
Resource labels as key:value pairs. Maximum of 64 per resource.
regionId : string
ID of the region where the target group resides.
targets : Target
A list of targets in the target group.
TargetState
State of the target that was returned after the last health check.
Status
Status of the target.
STATUS_UNSPECIFIEDStatus of the target.
INITIALThe network load balancer is setting up health checks for this target.
HEALTHYHealth check passed and the target is ready to receive traffic.
UNHEALTHYHealth check failed and the target is not receiving traffic.
DRAININGTarget is being deleted and the network load balancer is no longer sending traffic to this target.
INACTIVEThe network load balancer is stopped and not performing health checks on this target.
subnetId : string
ID of the subnet that the target is connected to.
address : string
IP address of the target.
status : Status
Status of the target.