Метод list
Возвращает список доступных ресурсов NetworkLoadBalancer в указанном каталоге.
HTTP-запрос
GET https://load-balancer.api.cloud.yandex.net/network-load-balancer/v1/networkLoadBalancers
Query-параметры
Параметр | Описание |
---|---|
folderId | Обязательное поле. Идентификатор каталога, которому принадлежит балансировщик. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50. |
pageSize | Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю NetworkLoadBalancer.name. 2. Операторы = или != для одиночных значений, IN или NOT IN для списков значений. 3. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]. . Максимальная длина строки в символах — 1000. |
Ответ
HTTP Code: 200 - OK
{
"networkLoadBalancers": [
{
"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",
// `networkLoadBalancers[].attachedTargetGroups[].healthChecks[]` включает только одно из полей `tcpOptions`, `httpOptions`
"tcpOptions": {
"port": "string"
},
"httpOptions": {
"port": "string",
"path": "string"
},
// конец списка возможных полей`networkLoadBalancers[].attachedTargetGroups[].healthChecks[]`
}
]
}
]
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
networkLoadBalancers[] | object Ресурс NetworkLoadBalancer. Подробнее см. в разделе Сетевой балансировщик нагрузки. |
networkLoadBalancers[]. id |
string Идентификатор балансировщика. |
networkLoadBalancers[]. folderId |
string Идентификатор каталога, которому принадлежит балансировщик. |
networkLoadBalancers[]. createdAt |
string (date-time) Время создания ресурса в формате RFC3339. Строка в формате RFC3339. |
networkLoadBalancers[]. name |
string Имя балансировщика. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. |
networkLoadBalancers[]. description |
string Описание балансировщика. Длина 0-256 символов. |
networkLoadBalancers[]. labels |
object Метки ресурса в формате |
networkLoadBalancers[]. regionId |
string Идентификатор каталога, которому принадлежит балансировщик. |
networkLoadBalancers[]. status |
string Состояние балансировщика.
|
networkLoadBalancers[]. type |
string Тип балансировщика. В настоящее время доступны только внешние балансировщики. Тип балансировщика нагрузки. В настоящее время доступны только внешние балансировщики.
|
networkLoadBalancers[]. sessionAffinity |
string Тип адресации. В настоящее время доступна только адресация по принципу 5-tuple. Тип адресации. В настоящее время доступна только адресация по принципу 5-tuple. Подробнее см. в разделе Основные понятия.
|
networkLoadBalancers[]. listeners[] |
object Ресурс Listener. Дополнительные сведения см. в разделе Обработчик |
networkLoadBalancers[]. listeners[]. name |
string Имя обработчика. У обработчиков одного балансировщика должны быть уникальные имена. Длина 3-63 символов. |
networkLoadBalancers[]. listeners[]. address |
string IP-адрес для обработчика. |
networkLoadBalancers[]. listeners[]. port |
string (int64) Порт. |
networkLoadBalancers[]. listeners[]. protocol |
string Сетевой протокол для входящего трафика. Сетевой протокол для использования при проверке.
|
networkLoadBalancers[]. attachedTargetGroups[] |
object Ресурс AttachedTargetGroup. Дополнительные сведения см. в разделе Целевые группы и ресурсы |
networkLoadBalancers[]. attachedTargetGroups[]. targetGroupId |
string Обязательное поле. Идентификатор целевой группы. Максимальная длина строки в символах — 50. |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[] |
object Ресурс HealthCheck. Подробнее см. в разделе Проверка состояния. |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. name |
string Обязательное поле. Название проверки состояния. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. Значение должно соответствовать регулярному выражению |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. interval |
string Интервал между проверками работоспособности. Формат значения: |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. timeout |
string Время, за которое целевой ресурс должен ответить на проверку. Формат значения: |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. unhealthyThreshold |
string (int64) Количество неудачных проверок работоспособности перед изменением состояния целевого ресурса на Допустимые значения — от 2 до 10 включительно. |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. healthyThreshold |
string (int64) Количество успешных проверок состояния, необходимых для установки целевому ресурсу статуса Допустимые значения — от 2 до 10 включительно. |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. tcpOptions |
object Протокол TCP. networkLoadBalancers[].attachedTargetGroups[].healthChecks[] включает только одно из полей tcpOptions , httpOptions Конфигурация проверки состояния по протоколу TCP. |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. tcpOptions. port |
string (int64) Настройки для проверок состояния по протоколу TCP. Допустимые значения — от 1 до 32767 включительно. |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. httpOptions |
object Протокол HTTP. networkLoadBalancers[].attachedTargetGroups[].healthChecks[] включает только одно из полей tcpOptions , httpOptions Конфигурация проверки состояния по протоколу HTTP. |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. httpOptions. port |
string (int64) Настройки для проверок состояния по протоколу HTTP. Допустимые значения — от 1 до 32767 включительно. |
networkLoadBalancers[]. attachedTargetGroups[]. healthChecks[]. httpOptions. path |
string URL для отправки запросов проверки состояния, который будет установлен всем ресурсам целевой группы. Например |
nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken, для перебора страниц результатов. |