Метод addListener

Добавляет обработчик в указанный балансировщик.

HTTP-запрос

POST https://load-balancer.api.cloud.yandex.net/load-balancer/v1/networkLoadBalancers/{networkLoadBalancerId}:addListener

Path-параметры

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

Параметры в теле запроса

{
  "listenerSpec": {
    "name": "string",
    "port": "string",
    "protocol": "string",
    "targetPort": "string",
    "externalAddressSpec": {
      "address": "string",
      "ipVersion": "string"
    }
  }
}
Поле Описание
listenerSpec object

Обязательное поле. Спецификация обработчика.

Спецификация обработчика, которая будет использоваться балансировщиком.

listenerSpec.
name
string

Обязательное поле. Имя обработчика. У обработчиков одного балансировщика должны быть уникальные имена. Длина 3-63 символов.

Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].

listenerSpec.
port
string (int64)

Порт для входящего трафика.

Допустимые значения — от 1 до 32767 включительно.

listenerSpec.
protocol
string
Обязательное поле. Сетевой протокол для входящего трафика.

Сетевой протокол для использования при проверке.

  • TCP: Протокол TCP.
listenerSpec.
targetPort
string (int64)

Порты целевых ресурсов для входящего трафика. Допустимые значения — от 1 до 32767 включительно.

listenerSpec.
externalAddressSpec
object
Спецификация внешнего IP-адреса.

Спецификация внешнего адреса для ListenerSpec.

listenerSpec.
externalAddressSpec.
address
string

Публичный IP-адрес для обработчика. Если адрес передается в методе update, он заменит существующий адрес обработчика.

listenerSpec.
externalAddressSpec.
ipVersion
string

Версия IP-адреса.

Версия IP-адресов, с которыми работает балансировщик нагрузки. В настоящее время доступны только адреса IPv4.

  • IPV4: Протокол IPv4.
  • IPV6: Протокол IPv6.

Ответ

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)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.

metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.

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, в описании метода приведена структура соответствующего ему поля response.