Подключиться
Yandex Network Load Balancer

TargetGroupService

Набор методов для управления ресурсами TargetGroup.

Вызов Описание
Get Возвращает указанный ресурс TargetGroup.
List Возвращает список TargetGroup ресурсов в указанном каталоге..
Create Создает целевую группу в указанном каталоге и добавляет в нее указанные целевые ресурсы.
Update Обновляет указанную целевую группу.
Delete Удаляет указанную целевую группу.
AddTargets Добавляет ресурсы в целевую группу.
RemoveTargets Удаляет ресурсы из целевой группы.
ListOperations Возвращает список операций для указанной целевой группы.

Вызовы TargetGroupService

Get

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

rpc Get (GetTargetGroupRequest) returns (TargetGroup)

GetTargetGroupRequest

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

TargetGroup

Поле Описание
id string
Только для вывода. Идентификатор целевой группы.
folder_id string
Идентификатор каталога, которому принадлежит целевая группа.
created_at google.protobuf.Timestamp
Только для вывода. Время создания ресурса в формате RFC3339 .
name string
Имя целевой группы. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание целевой группы. Длина 0-256 символов.
labels map<string,string>
Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
region_id string
Идентификатор региона, в котором находится целевая группа.
targets[] Target
Список целевых ресурсов в целевой группе.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

List

Возвращает список TargetGroup ресурсов в указанном каталоге..

rpc List (ListTargetGroupsRequest) returns (ListTargetGroupsResponse)

ListTargetGroupsRequest

Поле Описание
folder_id string
Обязательное поле. Идентификатор каталога для вывода списка целевых групп. Чтобы получить идентификатор каталога, используйте запрос TargetGroupService.List. Максимальная длина строки в символах — 50.
page_size int64
Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListTargetGroupsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
page_token string
Токен страницы. Установите значение page_token равным значению поля ListTargetGroupsResponse.next_page_token, прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter string
  1. Имя поля. В настоящее время фильтрация осуществляется только по полю TargetGroup.name.
  2. Операторы = или != для одиночных значений, IN или NOT IN для списков значений.
  3. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9].
Максимальная длина строки в символах — 1000.

ListTargetGroupsResponse

Поле Описание
target_groups[] TargetGroup
Список ресурсов TargetGroup.
next_page_token string
Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListTargetGroupsRequest.page_size, используйте next_page_token в качестве значения параметра ListTargetGroupsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token, для перебора страниц результатов.

TargetGroup

Поле Описание
id string
Только для вывода. Идентификатор целевой группы.
folder_id string
Идентификатор каталога, которому принадлежит целевая группа.
created_at google.protobuf.Timestamp
Только для вывода. Время создания ресурса в формате RFC3339 .
name string
Имя целевой группы. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание целевой группы. Длина 0-256 символов.
labels map<string,string>
Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
region_id string
Идентификатор региона, в котором находится целевая группа.
targets[] Target
Список целевых ресурсов в целевой группе.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

Create

Создает целевую группу в указанном каталоге и добавляет в нее указанные целевые ресурсы.

rpc Create (CreateTargetGroupRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:CreateTargetGroupMetadata

    Operation.response:TargetGroup

CreateTargetGroupRequest

Поле Описание
folder_id string
Обязательное поле. Идентификатор каталога для вывода списка целевых групп. Чтобы получить идентификатор каталога, используйте запрос TargetGroupService.List. Максимальная длина строки в символах — 50.
name string
Обязательное поле. Имя целевой группы. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание целевой группы. Максимальная длина строки в символах — 256.
labels map<string,string>
Метки ресурса в формате key:value. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
region_id string
Обязательное поле. Идентификатор зоны доступности, в которой находится целевая группа. Максимальная длина строки в символах — 50.
targets[] Target
Список целевых ресурсов в целевой группе.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<CreateTargetGroupMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<TargetGroup>
в случае успешного выполнения операции.

CreateTargetGroupMetadata

Поле Описание
target_group_id string
Идентификатор создаваемой целевой группы.

TargetGroup

Поле Описание
id string
Только для вывода. Идентификатор целевой группы.
folder_id string
Идентификатор каталога, которому принадлежит целевая группа.
created_at google.protobuf.Timestamp
Только для вывода. Время создания ресурса в формате RFC3339 .
name string
Имя целевой группы. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание целевой группы. Длина 0-256 символов.
labels map<string,string>
Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
region_id string
Идентификатор региона, в котором находится целевая группа.
targets[] Target
Список целевых ресурсов в целевой группе.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

Update

Обновляет указанную целевую группу.

rpc Update (UpdateTargetGroupRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:UpdateTargetGroupMetadata

    Operation.response:TargetGroup

UpdateTargetGroupRequest

Поле Описание
target_group_id string
Обязательное поле. Идентификатор изменяемого ресурса TargetGroup. Чтобы узнать идентификатор целевой группы, используйте запрос TargetGroupService.List. Максимальная длина строки в символах — 50.
update_mask google.protobuf.FieldMask
Маска, определяющая, какие поля ресурса TargetGroup будут обновлены.
name string
Имя целевой группы. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание целевой группы. Максимальная длина строки в символах — 256.
labels map<string,string>
Метки ресурса в формате ключ:значение.
Имеющийся набор меток полностью перезаписывается набором, переданным в запросе. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
targets[] Target
Новый список ресурсов для этой целевой группы.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<UpdateTargetGroupMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<TargetGroup>
в случае успешного выполнения операции.

UpdateTargetGroupMetadata

Поле Описание
target_group_id string
Идентификатор обновляемой целевой группы.

TargetGroup

Поле Описание
id string
Только для вывода. Идентификатор целевой группы.
folder_id string
Идентификатор каталога, которому принадлежит целевая группа.
created_at google.protobuf.Timestamp
Только для вывода. Время создания ресурса в формате RFC3339 .
name string
Имя целевой группы. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание целевой группы. Длина 0-256 символов.
labels map<string,string>
Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
region_id string
Идентификатор региона, в котором находится целевая группа.
targets[] Target
Список целевых ресурсов в целевой группе.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

Delete

Удаляет указанную целевую группу.

rpc Delete (DeleteTargetGroupRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:DeleteTargetGroupMetadata

    Operation.response:google.protobuf.Empty

DeleteTargetGroupRequest

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

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<DeleteTargetGroupMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<google.protobuf.Empty>
в случае успешного выполнения операции.

DeleteTargetGroupMetadata

Поле Описание
target_group_id string
Идентификатор удаляемой целевой группы.

AddTargets

Добавляет ресурсы в целевую группу.

rpc AddTargets (AddTargetsRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:AddTargetsMetadata

    Operation.response:TargetGroup

AddTargetsRequest

Поле Описание
target_group_id string
Обязательное поле. Идентификатор ресурса TargetGroup для добавления целевого ресурса. Чтобы узнать идентификатор целевой группы, используйте запрос TargetGroupService.List. Максимальная длина строки в символах — 50.
targets[] Target
Список целевых объектов для добавления в целевую группу. Минимальное количество элементов — 1.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<AddTargetsMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<TargetGroup>
в случае успешного выполнения операции.

AddTargetsMetadata

Поле Описание
target_group_id string
Идентификатор целевой группы, в которую добавляются целевые ресурсы.

TargetGroup

Поле Описание
id string
Только для вывода. Идентификатор целевой группы.
folder_id string
Идентификатор каталога, которому принадлежит целевая группа.
created_at google.protobuf.Timestamp
Только для вывода. Время создания ресурса в формате RFC3339 .
name string
Имя целевой группы. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание целевой группы. Длина 0-256 символов.
labels map<string,string>
Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
region_id string
Идентификатор региона, в котором находится целевая группа.
targets[] Target
Список целевых ресурсов в целевой группе.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

RemoveTargets

Удаляет ресурсы из целевой группы.

rpc RemoveTargets (RemoveTargetsRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:RemoveTargetsMetadata

    Operation.response:TargetGroup

RemoveTargetsRequest

Поле Описание
target_group_id string
Обязательное поле. Идентификатор целевой группы из которой будут удалены целевые ресурсы. Чтобы узнать идентификатор целевой группы, используйте запрос TargetGroupService.List. Максимальная длина строки в символах — 50.
targets[] Target
Список ресурсов для удаления из целевой группы. Минимальное количество элементов — 1.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<RemoveTargetsMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<TargetGroup>
в случае успешного выполнения операции.

RemoveTargetsMetadata

Поле Описание
target_group_id string
Идентификатор целевой группы, из которой удаляются ресурсы.

TargetGroup

Поле Описание
id string
Только для вывода. Идентификатор целевой группы.
folder_id string
Идентификатор каталога, которому принадлежит целевая группа.
created_at google.protobuf.Timestamp
Только для вывода. Время создания ресурса в формате RFC3339 .
name string
Имя целевой группы. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание целевой группы. Длина 0-256 символов.
labels map<string,string>
Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
region_id string
Идентификатор региона, в котором находится целевая группа.
targets[] Target
Список целевых ресурсов в целевой группе.

Target

Поле Описание
subnet_id string
Идентификатор подсети, к которой подключены целевые ресурсы. В пределах одной зоны доступности все ресурсы целевой группы должны быть подключены к одной подсети. Максимальная длина строки в символах — 50.
address string
IP-адрес целевого ресурса.

ListOperations

Возвращает список операций для указанной целевой группы.

rpc ListOperations (ListTargetGroupOperationsRequest) returns (ListTargetGroupOperationsResponse)

ListTargetGroupOperationsRequest

Поле Описание
target_group_id string
Обязательное поле. Идентификатор изменяемого ресурса TargetGroup. Чтобы узнать идентификатор целевой группы, используйте запрос TargetGroupService.List. Максимальная длина строки в символах — 50.
page_size int64
Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListTargetGroupOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
page_token string
Токен страницы. Установите значение page_token равным значению поля ListTargetGroupOperationsResponse.next_page_token, прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

ListTargetGroupOperationsResponse

Поле Описание
operations[] operation.Operation
Список операций для указанной целевой группы.
next_page_token string
Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListTargetGroupOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListTargetGroupOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token, для перебора страниц результатов.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any
Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
В этой статье: