Метод attachTargetGroup
Подключает целевую группу к указанному балансировщику.
HTTP-запрос
POST https://load-balancer.api.cloud.yandex.net/load-balancer/v1/networkLoadBalancers/{networkLoadBalancerId}:attachTargetGroup
Path-параметры
Параметр | Описание |
---|---|
networkLoadBalancerId | Обязательное поле. Идентификатор балансировщика, к которому будет подключена целевая группа. Чтобы получить идентификатор балансировщика, используйте запрос list. Максимальная длина строки в символах — 50. |
Параметры в теле запроса
{
"attachedTargetGroup": {
"targetGroupId": "string",
"healthChecks": [
{
"name": "string",
"interval": "string",
"timeout": "string",
"unhealthyThreshold": "string",
"healthyThreshold": "string",
// `attachedTargetGroup.healthChecks[]` включает только одно из полей `tcpOptions`, `httpOptions`
"tcpOptions": {
"port": "string"
},
"httpOptions": {
"port": "string",
"path": "string"
},
// конец списка возможных полей`attachedTargetGroup.healthChecks[]`
}
]
}
}
Поле | Описание |
---|---|
attachedTargetGroup | object Обязательное поле. Идентификатор целевой группы для подключения к балансировщику. Чтобы получить идентификатор балансировщика, используйте запрос list. Ресурс AttachedTargetGroup. Дополнительные сведения см. в разделе Целевые группы и ресурсы |
attachedTargetGroup. targetGroupId |
string Обязательное поле. Идентификатор целевой группы. Максимальная длина строки в символах — 50. |
attachedTargetGroup. healthChecks[] |
object Ресурс HealthCheck. Подробнее см. в разделе Проверка состояния. |
attachedTargetGroup. healthChecks[]. name |
string Обязательное поле. Название проверки состояния. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. Значение должно соответствовать регулярному выражению |
attachedTargetGroup. healthChecks[]. interval |
string Интервал между проверками работоспособности. Формат значения: |
attachedTargetGroup. healthChecks[]. timeout |
string Время, за которое целевой ресурс должен ответить на проверку. Формат значения: |
attachedTargetGroup. healthChecks[]. unhealthyThreshold |
string (int64) Количество неудачных проверок работоспособности перед изменением состояния целевого ресурса на Допустимые значения — от 2 до 10 включительно. |
attachedTargetGroup. healthChecks[]. healthyThreshold |
string (int64) Количество успешных проверок состояния, необходимых для установки целевому ресурсу статуса Допустимые значения — от 2 до 10 включительно. |
attachedTargetGroup. healthChecks[]. tcpOptions |
object Протокол TCP. attachedTargetGroup.healthChecks[] включает только одно из полей tcpOptions , httpOptions Конфигурация проверки состояния по протоколу TCP. |
attachedTargetGroup. healthChecks[]. tcpOptions. port |
string (int64) Настройки для проверок состояния по протоколу TCP. Допустимые значения — от 1 до 32767 включительно. |
attachedTargetGroup. healthChecks[]. httpOptions |
object Протокол HTTP. attachedTargetGroup.healthChecks[] включает только одно из полей tcpOptions , httpOptions Конфигурация проверки состояния по протоколу HTTP. |
attachedTargetGroup. healthChecks[]. httpOptions. port |
string (int64) Настройки для проверок состояния по протоколу HTTP. Допустимые значения — от 1 до 32767 включительно. |
attachedTargetGroup. healthChecks[]. httpOptions. path |
string URL для отправки запросов проверки состояния, который будет установлен всем ресурсам целевой группы. Например |
Ответ
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// включает только одно из полей `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// конец списка возможных полей
}
Ресурс Operation. Дополнительные сведения см. в разделе Объект Operation.
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
createdAt | string (date-time) Время создания ресурса в формате в RFC3339. Строка в формате RFC3339. |
createdBy | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modifiedAt | string (date-time) Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. Строка в формате RFC3339. |
done | boolean (boolean) Если значение равно |
metadata | object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |
error | object Описание ошибки в случае сбоя или отмены операции. включает только одно из полей error , response Описание ошибки в случае сбоя или отмены операции. |
error. code |
integer (int32) Код ошибки. Значение из списка google.rpc.Code. |
error. message |
string Текст ошибки. |
error. details[] |
object Список сообщений с подробными сведениями об ошибке. |
response | object включает только одно из полей error , response Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |