Network Load Balancer API, gRPC: NetworkLoadBalancerService.Get
Returns the specified NetworkLoadBalancer resource.
Get the list of available NetworkLoadBalancer resources by making a List request.
gRPC request
rpc Get (GetNetworkLoadBalancerRequest) returns (NetworkLoadBalancer)
GetNetworkLoadBalancerRequest
{
"network_load_balancer_id": "string"
}
|
Field |
Description |
|
network_load_balancer_id |
string ID of the NetworkLoadBalancer resource to return. |
NetworkLoadBalancer
{
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"region_id": "string",
"status": "Status",
"type": "Type",
"session_affinity": "SessionAffinity",
"listeners": [
{
"name": "string",
"address": "string",
"port": "int64",
"protocol": "Protocol",
"target_port": "int64",
"subnet_id": "string",
"ip_version": "IpVersion"
}
],
"attached_target_groups": [
{
"target_group_id": "string",
"health_checks": [
{
"name": "string",
"interval": "google.protobuf.Duration",
"timeout": "google.protobuf.Duration",
"unhealthy_threshold": "int64",
"healthy_threshold": "int64",
// Includes only one of the fields `tcp_options`, `http_options`
"tcp_options": {
"port": "int64"
},
"http_options": {
"port": "int64",
"path": "string"
}
// end of the list of possible fields
}
]
}
],
"deletion_protection": "bool"
}
A NetworkLoadBalancer resource. For more information, see Network Load Balancer.
|
Field |
Description |
|
id |
string ID of the network load balancer. |
|
folder_id |
string ID of the folder that the network load balancer belongs to. |
|
created_at |
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 |
object (map<string, string>) Resource labels as |
|
region_id |
string ID of the region that the network load balancer belongs to. |
|
status |
enum Status Status of the network load balancer.
|
|
type |
enum Type Type of the network load balancer. Only external network load balancers are available now.
|
|
session_affinity |
enum SessionAffinity Type of the session affinity. Only 5-tuple affinity is available now.
|
|
listeners[] |
List of listeners for the network load balancer. |
|
attached_target_groups[] |
List of target groups attached to the network load balancer. |
|
deletion_protection |
bool Specifies if network load balancer protected from deletion. |
Listener
A Listener resource. For more information, see Listener
|
Field |
Description |
|
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 |
enum Protocol Network protocol for incoming traffic.
|
|
target_port |
int64 Port of a target. |
|
subnet_id |
string ID of the subnet. |
|
ip_version |
enum IpVersion IP version of the external address.
|
AttachedTargetGroup
An AttachedTargetGroup resource. For more information, see Targets and groups.
|
Field |
Description |
|
target_group_id |
string Required field. ID of the target group. |
|
health_checks[] |
A health check to perform on the target group. |
HealthCheck
A HealthCheck resource. For more information, see Health check.
|
Field |
Description |
|
name |
string Required field. 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 |
The interval between health checks. The default is 2 seconds. |
|
timeout |
Timeout for a target to return a response for the health check. The default is 1 second. |
|
unhealthy_threshold |
int64 Number of failed health checks before changing the status to |
|
healthy_threshold |
int64 Number of successful health checks required in order to set the |
|
tcp_options |
Options for TCP health check. Includes only one of the fields Protocol to use for the health check. Either TCP or HTTP. |
|
http_options |
Options for HTTP health check. Includes only one of the fields Protocol to use for the health check. Either TCP or HTTP. |
TcpOptions
Configuration option for a TCP health check.
|
Field |
Description |
|
port |
int64 Port to use for TCP health checks. |
HttpOptions
Configuration option for an HTTP health check.
|
Field |
Description |
|
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. |