Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Network Load Balancer API, REST: NetworkLoadBalancer.List

Written by
Updated at December 17, 2024

Retrieves the list of NetworkLoadBalancer resources in the specified folder.

HTTP request

GET https://load-balancer.api.cloud.yandex.net/load-balancer/v1/networkLoadBalancers

Query parameters

Field

Description

folderId

string

Required field. ID of the folder that the network load balancer belongs to.
To get the folder ID, use a NetworkLoadBalancerService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a [.next_page_token]
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListNetworkLoadBalancersResponse.nextPageToken returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently you can only filter by the NetworkLoadBalancer.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

Response

HTTP Code: 200 - OK

{
  "networkLoadBalancers": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "regionId": "string",
      "status": "string",
      "type": "string",
      "sessionAffinity": "string",
      "listeners": [
        {
          "name": "string",
          "address": "string",
          "port": "string",
          "protocol": "string",
          "targetPort": "string",
          "subnetId": "string",
          "ipVersion": "string"
        }
      ],
      "attachedTargetGroups": [
        {
          "targetGroupId": "string",
          "healthChecks": [
            {
              "name": "string",
              "interval": "string",
              "timeout": "string",
              "unhealthyThreshold": "string",
              "healthyThreshold": "string",
              // Includes only one of the fields `tcpOptions`, `httpOptions`
              "tcpOptions": {
                "port": "string"
              },
              "httpOptions": {
                "port": "string",
                "path": "string"
              }
              // end of the list of possible fields
            }
          ]
        }
      ],
      "deletionProtection": "boolean"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

networkLoadBalancers[]

NetworkLoadBalancer

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
is larger than ListNetworkLoadBalancersRequest.pageSize, use
the nextPageToken as the value
for the ListNetworkLoadBalancersRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the 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

string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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 key:value pairs. Maximum of 64 per resource.

regionId

string

ID of the region that the network load balancer belongs to.

status

enum (Status)

Status of the network load balancer.

  • STATUS_UNSPECIFIED
  • CREATING: Network load balancer is being created.
  • STARTING: Network load balancer is being started.
  • ACTIVE: Network load balancer is active and sends traffic to the targets.
  • STOPPING: Network load balancer is being stopped.
  • STOPPED: Network load balancer is stopped and doesn't send traffic to the targets.
  • DELETING: Network load balancer is being deleted.
  • INACTIVE: The 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

enum (Type)

Type of the network load balancer. Only external network load balancers are available now.

  • TYPE_UNSPECIFIED
  • EXTERNAL: External network load balancer.
  • INTERNAL: Internal network load balancer.

sessionAffinity

enum (SessionAffinity)

Type of the session affinity. Only 5-tuple affinity is available now.

  • SESSION_AFFINITY_UNSPECIFIED
  • CLIENT_IP_PORT_PROTO: 5-tuple affinity.

listeners[]

Listener

List of listeners for the network load balancer.

attachedTargetGroups[]

AttachedTargetGroup

List of target groups attached to the network load balancer.

deletionProtection

boolean

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

string (int64)

Port.

protocol

enum (Protocol)

Network protocol for incoming traffic.

  • PROTOCOL_UNSPECIFIED
  • TCP
  • UDP

targetPort

string (int64)

Port of a target.

subnetId

string

ID of the subnet.

ipVersion

enum (IpVersion)

IP version of the external address.

  • IP_VERSION_UNSPECIFIED
  • IPV4: IPv4
  • IPV6: IPv6

AttachedTargetGroup

An AttachedTargetGroup resource. For more information, see Targets and groups.

Field

Description

targetGroupId

string

Required field. 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.

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

string (duration)

The interval between health checks. The default is 2 seconds.

timeout

string (duration)

Timeout for a target to return a response for the health check. The default is 1 second.

unhealthyThreshold

string (int64)

Number of failed health checks before changing the status to UNHEALTHY. The default is 2.

healthyThreshold

string (int64)

Number of successful health checks required in order to set the HEALTHY status for the target. The default is 2.

tcpOptions

TcpOptions

Options for TCP health check.

Includes only one of the fields tcpOptions, httpOptions.

Protocol to use for the health check. Either TCP or HTTP.

httpOptions

HttpOptions

Options for HTTP health check.

Includes only one of the fields tcpOptions, httpOptions.

Protocol to use for the health check. Either TCP or HTTP.

TcpOptions

Configuration option for a TCP health check.

Field

Description

port

string (int64)

Port to use for TCP health checks.

HttpOptions

Configuration option for an HTTP health check.

Field

Description

port

string (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 /.
Previous
Get
Next
Create