Method list
Lists target groups in the specified folder.
HTTP request
GET https://alb.api.cloud.yandex.net/apploadbalancer/v1/targetGroups
Query parameters
| Parameter | Description |
|---|---|
| folderId | Required. ID of the folder to list target groups in. To get the folder ID, make a list request. |
| pageSize | The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
| pageToken | Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
| filter | A filter expression that filters target groups listed in the response. The expression must specify: 1. The field name. Currently you can use filtering only on 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]. Example of a filter: name=my-target-group. The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"targetGroups": [
{
"id": "string",
"name": "string",
"description": "string",
"folderId": "string",
"labels": "object",
"targets": [
{
"subnetId": "string",
"privateIpv4Address": true,
"ipAddress": "string"
}
],
"createdAt": "string"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| targetGroups[] | object A target group resource. For details about the concept, see documentation. |
| targetGroups[]. id |
string ID of the target group. Generated at creation time. |
| targetGroups[]. name |
string Name of the target group. The name is unique within the folder. |
| targetGroups[]. description |
string Description of the target group. |
| targetGroups[]. folderId |
string ID of the folder that the target group belongs to. |
| targetGroups[]. labels |
object Target group labels as |
| targetGroups[]. targets[] |
object A target resource. For details about the concept, see documentation. |
| targetGroups[]. targets[]. subnetId |
string ID of the subnet that the target is connected to. |
| targetGroups[]. targets[]. privateIpv4Address |
boolean (boolean) If set, will not require |
| targetGroups[]. targets[]. ipAddress |
string IP address of the target. |
| targetGroups[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. |
| nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |