Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Network Load Balancer
  • Getting started
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • AddTargets
        • RemoveTargets
        • ListOperations
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • FAQ

In this article:

  • HTTP request
  • Path parameters
  • Response
  • Target
  1. API reference
  2. REST
  3. TargetGroup
  4. Get

Network Load Balancer API, REST: TargetGroup.Get

Written by
Yandex Cloud
Updated at December 17, 2024
  • HTTP request
  • Path parameters
  • Response
  • Target

Returns the specified TargetGroup resource.

HTTP requestHTTP request

GET https://load-balancer.api.cloud.yandex.net/load-balancer/v1/targetGroups/{targetGroupId}

Path parametersPath parameters

Field

Description

targetGroupId

string

Required field. ID of the TargetGroup resource to return.
To get the target group ID, use a TargetGroupService.List request.

ResponseResponse

HTTP Code: 200 - OK

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

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 text format.

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

name

string

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

description

string

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

labels

object (map<string, string>)

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

regionId

string

ID of the region where the target group resides.

targets[]

Target

A list of targets in the target group.

TargetTarget

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

Field

Description

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.

address

string

IP address of the target.

Was the article helpful?

Previous
Overview
Next
List
Yandex project
© 2025 Yandex.Cloud LLC