Метод update
Обновляет указанный балансировщик.
HTTP-запрос
PATCH https://load-balancer.api.cloud.yandex.net/network-load-balancer/v1/networkLoadBalancers/{networkLoadBalancerId}
Path-параметры
Параметр | Описание |
---|---|
networkLoadBalancerId | Обязательное поле. Идентификатор обновляемого балансировщика. Чтобы получить идентификатор балансировщика, используйте запрос list. Максимальная длина строки в символах — 50. |
Параметры в теле запроса
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "object",
"listenerSpecs": [
{
"name": "string",
"port": "string",
"protocol": "string",
"targetPort": "string",
"externalAddressSpec": {
"address": "string",
"ipVersion": "string"
}
}
],
"attachedTargetGroups": [
{
"targetGroupId": "string",
"healthChecks": [
{
"name": "string",
"interval": "string",
"timeout": "string",
"unhealthyThreshold": "string",
"healthyThreshold": "string",
// `attachedTargetGroups[].healthChecks[]` включает только одно из полей `tcpOptions`, `httpOptions`
"tcpOptions": {
"port": "string"
},
"httpOptions": {
"port": "string",
"path": "string"
},
// конец списка возможных полей`attachedTargetGroups[].healthChecks[]`
}
]
}
]
}
Поле | Описание |
---|---|
updateMask | string Маска, определяющая, какие поля ресурса NetworkLoadBalancer будут обновлены. Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре Если в запросе не передается |
name | string Имя балансировщика. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |
description | string Описание балансировщика. Максимальная длина строки в символах — 256. |
labels | object Метки ресурса в формате Имеющийся набор меток полностью перезаписывается набором, переданным в запросе. Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению |
listenerSpecs[] | object Спецификация обработчика, которая будет использоваться балансировщиком. |
listenerSpecs[]. name |
string Обязательное поле. Имя обработчика. У обработчиков одного балансировщика должны быть уникальные имена. Длина 3-63 символов. Значение должно соответствовать регулярному выражению |
listenerSpecs[]. port |
string (int64) Порт для входящего трафика. Допустимые значения — от 1 до 32767 включительно. |
listenerSpecs[]. protocol |
string Обязательное поле. Сетевой протокол для входящего трафика. Сетевой протокол для использования при проверке.
|
listenerSpecs[]. targetPort |
string (int64) Порты целевых ресурсов для входящего трафика. Допустимые значения — от 1 до 32767 включительно. |
listenerSpecs[]. externalAddressSpec |
object Спецификация внешнего IP-адреса. Спецификация внешнего адреса для |
listenerSpecs[]. externalAddressSpec. address |
string Публичный IP-адрес для обработчика. Если адрес передается в методе update, он заменит существующий адрес обработчика. |
listenerSpecs[]. externalAddressSpec. ipVersion |
string Версия IP-адреса. Версия IP-адресов, с которыми работает балансировщик нагрузки. В настоящее время доступны только адреса IPv4.
|
attachedTargetGroups[] | object Ресурс AttachedTargetGroup. Дополнительные сведения см. в разделе Целевые группы и ресурсы |
attachedTargetGroups[]. targetGroupId |
string Обязательное поле. Идентификатор целевой группы. Максимальная длина строки в символах — 50. |
attachedTargetGroups[]. healthChecks[] |
object Ресурс HealthCheck. Подробнее см. в разделе Проверка состояния. |
attachedTargetGroups[]. healthChecks[]. name |
string Обязательное поле. Название проверки состояния. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. Значение должно соответствовать регулярному выражению |
attachedTargetGroups[]. healthChecks[]. interval |
string Интервал между проверками работоспособности. Формат значения: |
attachedTargetGroups[]. healthChecks[]. timeout |
string Время, за которое целевой ресурс должен ответить на проверку. Формат значения: |
attachedTargetGroups[]. healthChecks[]. unhealthyThreshold |
string (int64) Количество неудачных проверок работоспособности перед изменением состояния целевого ресурса на Допустимые значения — от 2 до 10 включительно. |
attachedTargetGroups[]. healthChecks[]. healthyThreshold |
string (int64) Количество успешных проверок состояния, необходимых для установки целевому ресурсу статуса Допустимые значения — от 2 до 10 включительно. |
attachedTargetGroups[]. healthChecks[]. tcpOptions |
object Протокол TCP. attachedTargetGroups[].healthChecks[] включает только одно из полей tcpOptions , httpOptions Конфигурация проверки состояния по протоколу TCP. |
attachedTargetGroups[]. healthChecks[]. tcpOptions. port |
string (int64) Настройки для проверок состояния по протоколу TCP. Допустимые значения — от 1 до 32767 включительно. |
attachedTargetGroups[]. healthChecks[]. httpOptions |
object Протокол HTTP. attachedTargetGroups[].healthChecks[] включает только одно из полей tcpOptions , httpOptions Конфигурация проверки состояния по протоколу HTTP. |
attachedTargetGroups[]. healthChecks[]. httpOptions. port |
string (int64) Настройки для проверок состояния по протоколу HTTP. Допустимые значения — от 1 до 32767 включительно. |
attachedTargetGroups[]. 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, в описании метода приведена структура соответствующего ему поля |