Метод get
Возвращает указанный ресурс NetworkLoadBalancer.
Чтобы получить список доступных ресурсов NetworkLoadBalancer, используйте запрос list.
HTTP-запрос
GET https://load-balancer.api.cloud.yandex.net/network-load-balancer/v1/networkLoadBalancers/{networkLoadBalancerId}
Path-параметры
Параметр | Описание |
---|---|
networkLoadBalancerId | Идентификатор возвращаемого ресурса NetworkLoadBalancer. Чтобы получить идентификатор балансировщика, используйте запрос list. Максимальная длина строки в символах — 50. |
Ответ
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"regionId": "string",
"status": "string",
"type": "string",
"sessionAffinity": "string",
"listeners": [
{
"name": "string",
"address": "string",
"port": "string",
"protocol": "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[]`
}
]
}
]
}
Ресурс NetworkLoadBalancer. Подробнее см. в разделе Сетевой балансировщик нагрузки.
Поле | Описание |
---|---|
id | string Идентификатор балансировщика. |
folderId | string Идентификатор каталога, которому принадлежит балансировщик. |
createdAt | string (date-time) Время создания ресурса в формате RFC3339. Строка в формате RFC3339. |
name | string Имя балансировщика. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. |
description | string Описание балансировщика. Длина 0-256 символов. |
labels | object Метки ресурса в формате |
regionId | string Идентификатор каталога, которому принадлежит балансировщик. |
status | string Состояние балансировщика.
|
type | string Тип балансировщика. В настоящее время доступны только внешние балансировщики. Тип балансировщика нагрузки. В настоящее время доступны только внешние балансировщики.
|
sessionAffinity | string Тип адресации. В настоящее время доступна только адресация по принципу 5-tuple. Тип адресации. В настоящее время доступна только адресация по принципу 5-tuple. Подробнее см. в разделе Основные понятия.
|
listeners[] | object Ресурс Listener. Дополнительные сведения см. в разделе Обработчик |
listeners[]. name |
string Имя обработчика. У обработчиков одного балансировщика должны быть уникальные имена. Длина 3-63 символов. |
listeners[]. address |
string IP-адрес для обработчика. |
listeners[]. port |
string (int64) Порт. |
listeners[]. protocol |
string Сетевой протокол для входящего трафика. Сетевой протокол для использования при проверке.
|
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 для отправки запросов проверки состояния, который будет установлен всем ресурсам целевой группы. Например |