4.9.5
This commit is contained in:
143
4.9.4/06.02.58-Data_decort_cb_rg_list_computes.md
Normal file
143
4.9.4/06.02.58-Data_decort_cb_rg_list_computes.md
Normal file
@@ -0,0 +1,143 @@
|
||||
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||
|
||||
_Data source_ функция **decort_cb_rg_list_computes** служит для получения информации о компьютах ресурсной группы.
|
||||
|
||||
Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS).
|
||||
|
||||
Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_rg_list_computes**.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_cb_rg_list_computes** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы |
|
||||
| compute_id | int | :x: | Фильтр по ID компьюта |
|
||||
| name | string | :x: | Фильтр по имени компьюта |
|
||||
| account_id | int | :x: | Фильтр по ID аккаунта |
|
||||
| tech_status | string | :x: | Фильтр по тех. статусу |
|
||||
| status | string | :x: | Фильтр по статусу |
|
||||
| ip_address | string | :x: | Фильтр по IP адресу |
|
||||
| extnet_name | string | :x: | Фильтр по имени extnet |
|
||||
| extnet_id | int | :x: | Фильтр по ID extnet |
|
||||
| sort_by | string | :x: | Фильтр по одному из поддерживаемых полей, формат: +или- название поля |
|
||||
| page | int | :x: | Номер страницы |
|
||||
| size | int | :x: | Размер страницы |
|
||||
|
||||
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
|
||||
|
||||
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/wiki-terraform-provider-decort/src/branch/main/4.9.4/04.02-Инициализация-Terraform-провайдера-DECORT.md)).
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_cb_rg_list_computes** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | Уникальный идентификатор аккаунта-владельца ("account") данной виртуальной машины |
|
||||
| account_name | string | Имя аккаунта, которому принадлежит данная виртуальная машина |
|
||||
| affinity_label | string | Лейбл аффинити |
|
||||
| affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила аффинити для компьютов |
|
||||
| affinity_weight | int | weight аффинити |
|
||||
| anti_affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила анти аффинити для компьютов |
|
||||
| cpus | int | Количество виртуальных CPU, выделенных данному серверу |
|
||||
| created_by | string | Кем создан ресурс |
|
||||
| created_time | int | Время создания ресурса |
|
||||
| deleted_by | string | Кем удален ресурс |
|
||||
| deleted_time | int | Время удаления ресурса |
|
||||
| id | int | Идентификатор компьюта |
|
||||
| name | string | Имя виртуального сервера |
|
||||
| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине |
|
||||
| registered | bool | Компьют зарегестрирован |
|
||||
| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина |
|
||||
| rg_id | int | ID ресурсной группы |
|
||||
| status | string | Статус диска |
|
||||
| tech_status | string | Технический статус диска |
|
||||
| total_disk_size | int | Размер диска |
|
||||
| updated_by | string | Кем обновлен ресурс |
|
||||
| updated_time | int | Время обновления ресурса |
|
||||
| user_managed | bool | User managed |
|
||||
| vins_connected | int | Кол-во присоединенных винсов |
|
||||
|
||||
### Описание структуры affinity rules
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| guid | string | guid |
|
||||
| key | string | Ключ |
|
||||
| mode | string | Режим сравнения |
|
||||
| policy | string | Степень "строгости" этого правила |
|
||||
| topology | string | Топология |
|
||||
| value | string | Значение |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_cb_rg_list_computes**:
|
||||
|
||||
```terraform
|
||||
data "decort_cb_rg_list_computes" "list_computes" {
|
||||
#id ресурсной группы
|
||||
#обязательный параметр
|
||||
#тип - целое число
|
||||
rg_id = 123
|
||||
|
||||
#фильтр по id compute
|
||||
#опциональный параметр
|
||||
#тип - целое число
|
||||
#compute_id = 100
|
||||
|
||||
#фильтр по имени compute
|
||||
#опциональный параметр
|
||||
#тип - строка
|
||||
#name = "test"
|
||||
|
||||
#фильтр по id аккаунта
|
||||
#опциональный параметр
|
||||
#тип - целое число
|
||||
#account_id = 100
|
||||
|
||||
#фильтр по техническому статусу
|
||||
#опциональный параметр
|
||||
#тип - строка
|
||||
#tech_status = "STARTED"
|
||||
|
||||
#фильтр по статусу
|
||||
#опциональный параметр
|
||||
#тип - строка
|
||||
#status = "ENABLED"
|
||||
|
||||
#фильтр по ip address
|
||||
#опциональный параметр
|
||||
#тип - строка
|
||||
#ip_address = "1.1.1.1.1"
|
||||
|
||||
#фильтр по имени внешней сети
|
||||
#опциональный параметр
|
||||
#тип - строка
|
||||
#extnet_name = "test"
|
||||
|
||||
#фильтр по id внешней сети
|
||||
#опциональный параметр
|
||||
#тип - целое число
|
||||
#extnet_id = 100
|
||||
|
||||
#сортировка по одному из поддерживаемых полей
|
||||
#опциональный параметр
|
||||
#тип - строка
|
||||
#формат - "+поле" по возрастанию / "-поле" по убыванию
|
||||
#sort_by = "+name"
|
||||
|
||||
#номер страницы для отображения
|
||||
#опциональный параметр
|
||||
#тип - целое число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#page = 1
|
||||
|
||||
#размер страницы
|
||||
#опциональный параметр
|
||||
#тип - целое число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#size = 1
|
||||
}
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/wiki-terraform-provider-decort/src/branch/main/4.9.4/04.02-Инициализация-Terraform-провайдера-DECORT.md) и [пример](https://repository.basistech.ru/BASIS/wiki-terraform-provider-decort/src/branch/main/4.9.4/02.-Пример-работы.md)).
|
||||
|
||||
После успешного завершения такого вызова **decort_cb_rg_list_computes** в переменной `data.decort_cb_rg_list_computes.list_computes.items` будут сохранены возвращаемые значения.
|
||||
Reference in New Issue
Block a user