Method get

Returns the specified TargetGroup resource.

HTTP request

GET https://load-balancer.api.cloud.yandex.net/load-balancer/v1/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.