Contact UsGet started

Network Load Balancer API, REST: TargetGroup.List

Written by
Updated at October 17, 2024

Retrieves the list of TargetGroup resources in the specified folder.

HTTP request

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

Query parameters

Field

Description

folderId

string

Required field. ID of the folder to list target groups in.
To get the folder ID, use a TargetGroupService.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 ListTargetGroupsResponse.nextPageToken
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
ListTargetGroupsResponse.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 TargetGroup.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

{
  "targetGroups": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "string",
      "regionId": "string",
      "targets": [
        {
          "subnetId": "string",
          "address": "string"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Field

Description

targetGroups[]

TargetGroup

List of TargetGroup 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 ListTargetGroupsRequest.pageSize, use
the nextPageToken as the value
for the ListTargetGroupsRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

TargetGroup

A TargetGroup resource. For more information, see Target groups and resources.

Field

Description

id

string

Output only. ID of the target group.

folderId

string

ID of the folder that the target group belongs to.

createdAt

string (date-time)

Output only. 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 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.

Target

A Target resource. For more information, see Target groups and resources.

Field

Description

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