Метод get

Возвращает указанный ресурс TargetGroup.

HTTP-запрос

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

Path-параметры

Параметр Описание
targetGroupId Обязательное поле. Идентификатор возвращаемого ресурса TargetGroup. Чтобы узнать идентификатор целевой группы, используйте запрос list. Максимальная длина строки в символах — 50.

Ответ

HTTP Code: 200 - OK

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

Ресурс TargetGroup. Подробнее см. в разделе Целевые группы и ресурсы.

Поле Описание
id string

Только для вывода. Идентификатор целевой группы.

folderId string

Идентификатор каталога, которому принадлежит целевая группа.

createdAt string (date-time)

Только для вывода. Время создания ресурса в формате RFC3339 .

Строка в формате RFC3339.

name string

Имя целевой группы. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.

description string

Описание целевой группы. Длина 0-256 символов.

labels object

Метки ресурса в формате key:value. Максимум 64 метки на ресурс.

regionId string

Идентификатор региона, в котором находится целевая группа.

targets[] object

Ресурс Target. Подробнее см. в разделе Целевые группы и ресурсы.

targets[].
subnetId
string

Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети.

Максимальная длина строки в символах — 50.

targets[].
address
string

IP-адрес целевого ресурса.