Network Load Balancer API, gRPC: NetworkLoadBalancerService.List
Retrieves the list of NetworkLoadBalancer resources in the specified folder.
gRPC request
rpc List (ListNetworkLoadBalancersRequest) returns (ListNetworkLoadBalancersResponse)
ListNetworkLoadBalancersRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string",
"filter": "string"
}
Field |
Description |
folderId |
string Required field. ID of the folder that the network load balancer belongs to. |
pageSize |
int64 The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters resources listed in the response.
|
ListNetworkLoadBalancersResponse
{
"networkLoadBalancers": [
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"regionId": "string",
"status": "Status",
"type": "Type",
"sessionAffinity": "SessionAffinity",
"listeners": [
{
"name": "string",
"address": "string",
"port": "int64",
"protocol": "Protocol",
"targetPort": "int64",
"subnetId": "string",
"ipVersion": "IpVersion"
}
],
"attachedTargetGroups": [
{
"targetGroupId": "string",
"healthChecks": [
{
"name": "string",
"interval": "google.protobuf.Duration",
"timeout": "google.protobuf.Duration",
"unhealthyThreshold": "int64",
"healthyThreshold": "int64",
// Includes only one of the fields `tcpOptions`, `httpOptions`
"tcpOptions": {
"port": "int64"
},
"httpOptions": {
"port": "int64",
"path": "string"
}
// end of the list of possible fields
}
]
}
],
"deletionProtection": "bool"
}
],
"nextPageToken": "string"
}
Field |
Description |
networkLoadBalancers[] |
List of NetworkLoadBalancer resources. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
NetworkLoadBalancer
A NetworkLoadBalancer resource. For more information, see Network Load Balancer.
Field |
Description |
id |
string ID of the network load balancer. |
folderId |
string ID of the folder that the network load balancer belongs to. |
createdAt |
Creation timestamp in RFC3339 |
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 |
regionId |
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.
|
sessionAffinity |
enum SessionAffinity Type of the session affinity. Only 5-tuple affinity is available now.
|
listeners[] |
List of listeners for the network load balancer. |
attachedTargetGroups[] |
List of target groups attached to the network load balancer. |
deletionProtection |
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.
|
targetPort |
int64 Port of a target. |
subnetId |
string ID of the subnet. |
ipVersion |
enum IpVersion IP version of the external address.
|
AttachedTargetGroup
An AttachedTargetGroup resource. For more information, see Targets and groups.
Field |
Description |
targetGroupId |
string Required field. ID of the target group. |
healthChecks[] |
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. |
unhealthyThreshold |
int64 Number of failed health checks before changing the status to |
healthyThreshold |
int64 Number of successful health checks required in order to set the |
tcpOptions |
Options for TCP health check. Includes only one of the fields Protocol to use for the health check. Either TCP or HTTP. |
httpOptions |
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. |