4.2 KiB
Data source функция dynamix_stack_list служит для получения информации о списке всех доступных stack. Stack - вычислительный узел.
Аргументы
Data source функция dynamix_stack_list принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|---|---|---|---|
| by_id | int | ❌ | фильтр по ID вычислительного узла (stack) |
| name | string | ❌ | фильтр по наименованию stack |
| type | string | ❌ | фильтр по типу stack |
| status | string | ❌ | фильтр по статусу stack |
| sort_by | string | ❌ | Фильтр по одному из поддерживаемых полей, формат: +или- название поля |
| page | int | ❌ | Номер страницы для вывода |
| size | int | ❌ | Размер страницы для вывода |
Возвращаемые значения
В случае успешного выполнения data source функция dynamix_stack_list возвращает в указанную при вызове переменную, в поле items, массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
|---|---|---|
| stack_id | int | ID вычислительного узла (stack) |
| name | string | Наименование stack |
| status | string | Статус stack |
| type | string | Тип stack |
Пример использования
Пример вызова data source функции dynamix_stack_list:
data "dynamix_stack_list" "stack_list" {
#необязательный параметр
#тип - целое число
#фильтрация списка для получения информации о конкретном stack по его id
#by_id = 2
#необязательный параметр
#тип - строка
#фильтрация списка для получения информации о конкретном stack по его имени
#name = "alpha-cpu-04"
#необязательный параметр
#тип - строка
#фильтрация списка для получения информации о конкретном stack по его типу
#type = "KVM"
#необязательный параметр
#тип - строка
#фильтрация списка для получения информации о конкретном stack по его статусу
#status = "ENABLED"
#сортировка по одному из поддерживаемых полей
#опциональный параметр
#тип - строка
#формат - "+поле" по возрастанию / "-поле" по убыванию
#sort_by = "+name"
#номер страницы для отображения
#опциональный параметр
#тип - целое число
#если не задан - выводятся все доступные данные
#page = 2
#размер страницы
#опциональный параметр
#тип - целое число
#если не задан - выводятся все доступные данные
#size = 3
}
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DYNAMIX см. соответствующий раздел).
После успешного завершения такого вызова dynamix_stack_list в переменной data.dynamix_stack_list.sl.items будут сохранены возвращаемые значения.