|
|
|
|
@ -0,0 +1,99 @@
|
|
|
|
|
Функция доступна в провайдере версии 3.0 и выше.
|
|
|
|
|
|
|
|
|
|
_Data source_ функция **decort_cb_rg_list** служит для получения информации об имеющихся ресурсных группах.
|
|
|
|
|
|
|
|
|
|
## Аргументы
|
|
|
|
|
_Data source_ функция **decort_cb_rg_list** принимает следующие аргументы:
|
|
|
|
|
|
|
|
|
|
| Аргумент | Тип | Обязательный | Описание |
|
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
|
| by_id | int | :x: | Фильтр по ID ресурсной группы |
|
|
|
|
|
| name | string | :x: | Фильтр по имени ресурсной группы |
|
|
|
|
|
| account_id | int | :x: | Фильтр поID аккаунта |
|
|
|
|
|
| account_name | string | :x: | Фильтр по названию аккаунта |
|
|
|
|
|
| created_after | int | :x: | Отдает все рес. группы созданные после определенного времени (unix timstamp) |
|
|
|
|
|
| created_before | int | :x: | Отдает все рес. группы созданные до определенного времени (unix timstamp) |
|
|
|
|
|
| status | string | :x: | Фильтр по статусу |
|
|
|
|
|
| lock_status | string | :x: | Фильтр по локстатусу |
|
|
|
|
|
| includedeleted | bool | :x: | Включение удаленных rg в результат поиска |
|
|
|
|
|
| page | int | :x: | Номер страниц |
|
|
|
|
|
| size | int | :x: | Размер страницы |
|
|
|
|
|
|
|
|
|
|
## Возвращаемые значения
|
|
|
|
|
В случае успешного выполнения _data source_ функция **decort_cb_rg_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
|
|
|
|
|
|
|
|
|
| Параметр | Тип | Описание |
|
|
|
|
|
| --- | --- | --- |
|
|
|
|
|
| account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. |
|
|
|
|
|
| account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. |
|
|
|
|
|
| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control |
|
|
|
|
|
| cpu_allocation_parameter | string | Параметр выделения CPU |
|
|
|
|
|
| cpu_allocation_ratio | float | Отношение выделения CPU |
|
|
|
|
|
| created_by | string | Пользователь - создатель ресурсной группы |
|
|
|
|
|
| created_time | int | Время создания ресурсной группы |
|
|
|
|
|
| def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.<br/>Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. |
|
|
|
|
|
| def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:<br> * EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`<br> * PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`<br> * NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. |
|
|
|
|
|
| deleted_by | string | Информация о том, кто удалил группу |
|
|
|
|
|
| deleted_time | int | Время удаления группы |
|
|
|
|
|
| desc | string | Текстовое описание данной ресурсной группы. |
|
|
|
|
|
| dirty | bool | Dirty |
|
|
|
|
|
| gid | int | GRID ID |
|
|
|
|
|
| guid | int | ID ресурса |
|
|
|
|
|
| lock_status | string | Статус доступности |
|
|
|
|
|
| milestones | int | Вехи |
|
|
|
|
|
| name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). |
|
|
|
|
|
| rg_id | int | Идентификатор данной ресурсной группы. |
|
|
|
|
|
| register_computes | bool | Флаг регистрации ВМ во внешней системе |
|
|
|
|
|
| resource_limits | []Struct [см. ниже](#описание-структуры-resource_limits) | Лимиты ресурсов |
|
|
|
|
|
| resource_types | []string | Типы ресурсов |
|
|
|
|
|
| secret | string | Секрет |
|
|
|
|
|
| status | string | Статус ресурсной группы |
|
|
|
|
|
| uniq_pools | []string | Список пулов. Например, ["sep1_poolName1", "sep2_poolName2"] |
|
|
|
|
|
| updated_by | string | Кем был обновлен ресурс |
|
|
|
|
|
| updated_time | int | Время последнего обновления ресурса |
|
|
|
|
|
| vins | []int | Список виртуальных сетей |
|
|
|
|
|
| vms | []int | Список id компьютов |
|
|
|
|
|
|
|
|
|
|
### Описание структуры acl
|
|
|
|
|
| Параметр | Тип | Описание |
|
|
|
|
|
| --- | --- | --- |
|
|
|
|
|
| explicit | bool | Видимость аккаунта |
|
|
|
|
|
| guid | string | GUID |
|
|
|
|
|
| right | string | Права |
|
|
|
|
|
| status | string | Статус |
|
|
|
|
|
| type | string | Тип |
|
|
|
|
|
| user_group_id | string | ID группы юзеров |
|
|
|
|
|
|
|
|
|
|
### Описание структуры resource_limits
|
|
|
|
|
| Параметр | Тип | Описание |
|
|
|
|
|
| --- | --- | --- |
|
|
|
|
|
| cu_c | float | Количество ядер CPU |
|
|
|
|
|
| cu_d | float | Размер диска |
|
|
|
|
|
| cu_dm | float | Использованный размер хранилища виртуального диска |
|
|
|
|
|
| cu_i | float | Количество публичных IP адресов |
|
|
|
|
|
| cu_m | float | размер RAM |
|
|
|
|
|
| cu_np | float | Хранилище траффика |
|
|
|
|
|
| gpu_units | float | количество GPU ядер |
|
|
|
|
|
|
|
|
|
|
## Пример использования
|
|
|
|
|
Пример вызова _data source_ функции **decort_cb_rg_list**:
|
|
|
|
|
```terraform
|
|
|
|
|
data "decort_cb_rg_list" "rl" {
|
|
|
|
|
#by_id = 100
|
|
|
|
|
#name = "test"
|
|
|
|
|
#account_id = 11111
|
|
|
|
|
#account_name = "test"
|
|
|
|
|
#created_after = 123
|
|
|
|
|
#created_before = 123
|
|
|
|
|
#status = "ENABLED"
|
|
|
|
|
#includedeleted = false
|
|
|
|
|
#page = 1
|
|
|
|
|
#size = 2
|
|
|
|
|
}
|
|
|
|
|
# once the above directive completes, rg list will be accessible
|
|
|
|
|
# as data.decort_cb_rg_list.rl.items
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
|
|
|
|
|
|
|
|
|
После успешного завершения такого вызова **decort_cb_rg_list** в переменной `data.decort_cb_rg_list.rl` будут сохранены возвращаемые значения.
|
