Created 06.01.42 Data функция decort_disk_list_unattached получение информации о неподключенных дисках (markdown)

stSolo
2022-10-27 14:54:43 +03:00
parent f4094f65a7
commit 32f10bc2c0

@@ -0,0 +1,64 @@
Функция доступна в провайдере версии 3.2 и выше.
_Data source_ функция **decort_disk_list_unattached** служит для получения информации о неподключенных к виртуальным машинам дисках.
## Аргументы
_Data source_ функция **decort_disk_list_unattached** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| account_id | int | :x: | id аккаунта для получения списка дисков |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_disk_list_unattached** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | id аккаунта |
| account_name | string | имя аккаунта |
| created_time | int | Время создания диска |
| deleted_time | int | Время удаления диска |
| desc | string | Описание диска |
| destruction_time | int | Время уничтожения диска |
| devicename | string | Имя устройства |
| gid | int | Grid id |
| disk_id | int | id диска |
| image_id | int | id образа |
| images | []int | id образов |
| iotune | Struct{<br/>total_iops_sec int<br/>} | Информация об IO-интерфейсах<br/>Общее кол-во операций в секунду<br/>&nbsp;<br/> |
| machine_id | int | id маишны (устаревшее) |
| machine_name | string | Наименование машины (устаревшее) |
| name | string | Наименование диска |
| order | int | Номер диска в последовательности |
| params | string | Параметры диска |
| parent_id | int | id родителя |
| pci_slot | int | id pci слота |
| pool | string | Наименование пула диска |
| purge_time | int | Время удаления |
| res_id | string | Идентификатор ресурса |
| res_name | string | Наименование ресурсов |
| role | string | Роль диска
| sep_id | int | id sep |
| sep_type | string | Тип sep |
| size_max | int | Максимальный размер диска |
| snapshots | []Struct{<br/>guid string<br/>label string<br/>res_id string<br/>snap_set_guid string<br/>snap_set_time int<br/>timestamp int<br/>} | Информация о снимках состояний диска<br/>guid снимка<br/>Наименование снимка<br/>id ресурса снимка<br/>Установленный guid снимка<br/>Установленное время снимка<br/>Время снимка<br>&nbsp;<br/> |
| status | string | Статус диска
| tech_status | string | Технический статус диска |
| type | string | Тип диска
| vmid | int | id виртуальной машины |
## Пример использования
Пример вызова _data source_ функции **decort_disk_list_unattched**:
```terraform
data "decort_disk_list_unattached" "dlu" {
#id аккаунта для получения списка дисков
#опциональный параметр
#тип - число
#account_id = 11111
}
# once the above directive completes, disk list will be accessible
# as data.decort_disk_list_unattached.dlu.items
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/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_disk_list_unattached** в переменной `data.decort_disk_list_unattached.dlu` будут сохранены возвращаемые значения.