Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Network Load Balancer
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Network load balancers
      • Create a network load balancer
      • Create an internal network load balancer
      • Start a load balancer
      • Stop a load balancer
      • Delete a load balancer
      • Check target health statuses
      • Add a listener
      • Delete a listener
    • Target groups
      • Create a target group
      • Attach a target group to a load balancer
      • Detach a target group from a load balancer
      • Delete a target group
  • Concepts
    • Network load balancer
    • Internal network load balancer
    • Listener
    • Targets and groups
    • Resource health checks
    • Quotas and limits
  • Best practices for using the service
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • NetworkLoadBalancerService
      • TargetGroupService
      • OperationService
    • REST
      • Overview
      • NetworkLoadBalancer
        • Overview
        • addListener
        • attachTargetGroup
        • create
        • delete
        • detachTargetGroup
        • get
        • getTargetStates
        • list
        • listOperations
        • removeListener
        • start
        • stop
        • update
      • TargetGroup
        • Overview
        • addTargets
        • create
        • delete
        • get
        • list
        • listOperations
        • removeTargets
        • update
      • Operation
        • Overview
        • get
  • Questions and answers
  1. API reference
  2. REST
  3. TargetGroup
  4. get

Method get

  • HTTP request
  • Path parameters
  • Response

Returns the specified TargetGroup resource.

HTTP request

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

Path parameters

Parameter Description
targetGroupId Required. ID of the TargetGroup resource to return. To get the target group ID, use a list request. The maximum string length in characters is 50.

Response

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.

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

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

regionId string

ID of the region where the target group resides.

targets[] object

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

targets[].
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.

The maximum string length in characters is 50.

targets[].
address
string

IP address of the target.

In this article:
  • HTTP request
  • Path parameters
  • Response
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC