Method list

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

Parameter Description
folderId Required. ID of the folder to list target groups in. To get the folder ID, use a list request. The maximum string length in characters is 50.
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter 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. Can be either = or != for single values, or IN or NOT IN for lists of values. 3. The value. Must be 3-63 characters long and match the regular expression ^[a-z][-a-z0-9]{1,61}[a-z0-9]$. The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

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

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

targetGroups[].
id
string

Output only. ID of the target group.

targetGroups[].
folderId
string

ID of the folder that the target group belongs to.

targetGroups[].
createdAt
string (date-time)

Output only. Creation timestamp in RFC3339 text format.

String in RFC3339 text format.

targetGroups[].
name
string

Name of the target group. The name is unique within the folder. 3-63 characters long.

targetGroups[].
description
string

Description of the target group. 0-256 characters long.

targetGroups[].
labels
object

Resource labels as key:value pairs. Мaximum of 64 per resource.

targetGroups[].
regionId
string

ID of the region where the target group resides.

targetGroups[].
targets[]
object

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

targetGroups[].
targets[].
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.

The maximum string length in characters is 50.

targetGroups[].
targets[].
address
string

IP address of the target.

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.