Contact UsGet started

Application Load Balancer API, REST: TargetGroup.Get

Written by
Updated at October 17, 2024

Returns the specified target group.

To get the list of all available target groups, make a List request.

HTTP request

GET https://alb.api.cloud.yandex.net/apploadbalancer/v1/targetGroups/{targetGroupId}

Path parameters

Field

Description

targetGroupId

string

Required field. ID of the target group to return.

To get the target group ID, make a TargetGroupService.List request.

Response

HTTP Code: 200 - OK

{
  "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"
}

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 key:value pairs.
For details about the concept, see documentation.

targets[]

Target

List of targets in the target group.

createdAt

string (date-time)

Creation timestamp.

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).

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 ipAddress.

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 subnet_id to validate the target.
Instead, the address should belong to one of the following ranges:
10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16
Only one of subnet_id or private_ipv4_address should be set.
Previous
Overview
Next
List