Network Load Balancer API, REST: TargetGroup.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
Field |
Description |
folderId |
string Required field. ID of the folder to list target groups in. |
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 resources listed in the response.
|
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[] |
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 |
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 String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the target group. |
description |
string Description of the target group. 0-256 characters long. |
labels |
string Resource labels as |
regionId |
string ID of the region where the target group resides. |
targets[] |
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. |
address |
string IP address of the target. |