terraform-provider-dynamix

11 KiB

Raw Permalink Blame History Unescape Escape

Data source функция dynamix_lb_list служит для получения информации об имеющихся в облачной платформе балансировщиках нагрузки.

Аргументы

Data source функция dynamix_lb_list принимает следующие аргументы:

Аргумент	Тип	Обязательный	Описание
by_id	int	❌	Фильтр по ID балансировщика
name	string	❌	Фильтр по имени балансировщика
account_id	int	❌	Фильтр по ID аккаунта
rg_id	int	❌	Фильтр по ID рес. группы
tech_status	string	❌	Фильтр по тех. статусу
status	string	❌	Фильтр по статусу
front_ip	string	❌	Фильтр по IP фронтенда
back_ip	string	❌	Фильтр по IP бэкенда
sort_by	string	❌	Фильтр по одному из поддерживаемых полей, формат: +или- название поля
page	int	❌	Номер страниц
size	int	❌	Размер страницы
includedeleted	bool	❌	Включить в результат удаленные балансировщики

Возвращаемые значения

В случае успешного выполнения data source функция dynamix_lb_list возвращает в указанную при вызове переменную, в поле items, массив, каждый элемент которого состоит из следующих параметров:

Параметр	Тип	Описание
ha_mode	bool	Флаг, показывающий, включен ли режим haproxy
backends	[]Struct{} см. ниже	Список бекендов
created_by	string	Аккаунт, создавший балансировщик
created_time	int	Время создания
deleted_by	string	Кем балансировщик был удален
deleted_by	int	Время удаления
desc	string	Описание
dp_api_user	string	Имя пользователя для работы
dp_api_password	string	Пароль пользователя
extnet_id	int	ID внешней сети
frontends	[]Struct{} см. ниже	Список фронтендов
gid	int	Grid ID балансировщика
guid	int	ID балансировщика
lb_id	int	ID балансировщика
manager_id	int	ID ресурса, к которому принадлежит данный балансировщик
manager_type	string	Тип ресурса, к которому принадлежит данный балансировщик
image_id	int	ID образа
milestones	int	Вехи
name	string	Имя балансировщика
part_k8s	bool	Является ли балансироващик частью кластера
primary_node	Struct{} см. описание узлов	Главный узел
rg_id	int	ID ресурсной группы
rg_name	string	Имя ресурсной группы
secondary_node	Struct{} см. описание узлов	Второй узел
status	string	Статус
tech_status	string	Технический статус
updated_by	string	Кем балансировщик был обновлен
updated_time	string	Время последнего обновления
user_managed	bool	Флаг указывающий, может ли пользователь управлять балансировщиком напрямую
vins_id	int	ID виртуальной сети

Описание структуры backend

Параметр	Тип	Описание
algorithm	string	Алгоритм работы бекенда
name	string	Имя бекенда
server_default_settings	Struct{} см. ниже	Описание настроек серверов бекенда по умолчанию
servers	[]Struct{} см. ниже	Список серверов

Описание структуры настроек

Параметр	Тип	Описание
downinter	int	Интервал между проверками на недоступность сервера
inter	int	Интервал между проверками на доступность сервера
rise	int	Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования
fall	int	Кол-во неудачных попыток, после которых, сервер получит статус "unavailable"
slowstart	int	Интервал, в мс, в через который сервер получит статус "available"
maxconn	int	Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования
maxqueue	int	Кол-во соедений в очереди к серверу
weight	int	Вес сервера для работы алгоритма балансирования по весу

Описание структуры сервера

Параметр	Тип	Описание
address	string	Адрес сервера
check	string	Включены ли проверки
name	string	Имя сервера
port	int	Порт сервера
server_settings	см. Описание структуры настроек	Настройки сервера

Описание структуры фронтенда

Параметр	Тип	Описание
backend	string	Имя бекенда, к которому подключен фронтенд
name	string	Имя фронтенда
bindings	[]Struct{} см. ниже	Привязки фронтенда

Описание структуры привязки фронтенда

Параметр	Тип	Описание
address	string	Адрес, к которому привязан фронтенд
name	string	Имя привязки
port	int	Порт привязки

Описание структуры узлов

Параметр	Тип	Описание
backend_ip	string	IP адрес бекенда
compute_id	int	ID виртуальной машины
frontend_ip	string	IP адрес фронтенда
mgmt_ip	string	IP адрес
network_id	int	ID сети

Пример использования

Пример вызова data source функции dynamix_lb_list:

data "dynamix_lb_list" "lbl" {
  #фильтр по id балансировщика нагрузки 
  #опциональный параметр
  #тип - целое число
  #by_id = 100

  #фильтр по имени балансировщика нагрузки
  #опциональный параметр
  #тип - строка
  #name = "test"

  #id аккаунта для получения списка балансировщиков нагрузки
  #опциональный параметр 
  #тип - целое число
  #account_id = 11111

  #фильтр по id ресурсной группы
  #опциональный параметр
  #тип - целое число
  #rg_id = 100

  #фильтр по техническому статусу
  #опциональный параметр
  #тип - строка
  #tech_status = "STOPPED"

  #фильтр по статусу
  #опциональный параметр
  #тип - строка
  #status = "ENABLED"

  #фильтр по IP front
  #опциональный параметр
  #тип - строка
  #front_ip = "ENABLED"

  #фильтр по IP back
  #опциональный параметр
  #тип - строка
  #back_ip = "ENABLED"

  #флаг влючения в результат удаленных балансировщиков нагрузки
  #опциональный параметр
  #тип - булев
  #значение по-умолчанию - false
  #если не задан - выводятся все доступные неудаленные балансировщики
  #includedeleted = true

  #сортировка по одному из поддерживаемых полей
  #опциональный параметр
  #тип - строка
  #формат - "+поле" по возрастанию / "-поле" по убыванию
  #sort_by = "+name"

  #номер страницы для отображения
  #опциональный параметр
  #тип - целое число
  #если не задан - выводятся все доступные данные
  #page = 1

  #размер страницы
  #опциональный параметр
  #тип - целое число
  #если не задан - выводятся все доступные данные
  #size = 1
}

После успешного завершения такого вызова dynamix_lb_list в переменной data.dynamix_lb_list.lbl будут сохранены возвращаемые значения.

11 KiB Raw Permalink Blame History Unescape Escape