Application Load Balancer API, REST: TargetGroup.List
Lists target groups in the specified folder.
HTTP request
GET https://alb.api.cloud.yandex.net/apploadbalancer/v1/targetGroups
Query parameters
Field |
Description |
folderId |
string Required field. ID of the folder to list target groups in. To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. |
pageSize |
string (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 target groups listed in the response. The expression must specify:
|
Response
HTTP Code: 200 - OK
{
"targetGroups": [
{
"id": "string",
"name": "string",
"description": "string",
"folderId": "string",
"labels": "string",
"targets": [
{
// Includes only one of the fields `ipAddress`
"ipAddress": "string",
// end of the list of possible fields
"subnetId": "string",
"privateIpv4Address": "boolean"
}
],
"createdAt": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
targetGroups[] |
List of target groups in the specified folder. |
nextPageToken |
string Token for getting the next page of the list. If the number of results is greater than Each subsequent page will have its own |
TargetGroup
A target group resource.
For details about the concept, see documentation.
Field |
Description |
id |
string ID of the target group. Generated at creation time. |
name |
string Name of the target group. The name is unique within the folder. |
description |
string Description of the target group. |
folderId |
string ID of the folder that the target group belongs to. |
labels |
string Target group labels as |
targets[] |
List of targets in the target group. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
Target
A target resource.
For details about the concept, see documentation.
Field |
Description |
ipAddress |
string IP address of the target. Includes only one of the fields Reference to the target. As of now, targets must only be referred to by their IP addresses. |
subnetId |
string ID of the subnet that the target is connected to. |
privateIpv4Address |
boolean If set, will not require |